Sign in
policy/version

Edits a policy version

put/policy/{packageName}/version/{version}

Path parameters

packageNamestring required
Example:@vincent/foo-bar-policy

Package name of the policy to edit a version for

versionstring required
Example:1.0.0

Version number to edit

Request body

changesstring required

Updated changelog information

Example request

{
  "changes": "Updated changelog information"
}

Response

Successful operation

_idstring required

Document ID

updatedAtstring date-time required

Timestamp when this was last modified

createdAtstring date-time required

Timestamp when this was created

packageNamestring required

Policy package name

versionstring required

Policy version

changesstring required

Changelog information for this version

repositorystring[] required

Repository URLs

descriptionstring required

Policy description

keywordsstring[] required

Keywords for the policy

dependenciesstring[] required

Dependencies of the policy

homepagestring uri

Policy homepage

status'invalid' | 'validating' | 'valid' | 'error' required

Policy status

ipfsCidstring required

IPFS CID

Example response

{
  "packageName": "@vincent/foo-bar-policy",
  "version": "1.0.0",
  "changes": "Initial release",
  "description": "This policy is a foo bar policy",
  "keywords": [
    "defi",
    "memecoin"
  ],
  "author": {
    "name": "Developer Name",
    "email": "contact@example.com",
    "url": "https://example.com"
  },
  "contributors": [
    {
      "name": "Contributor Name",
      "email": "contributor@example.com",
      "url": "https://contributor-site.example.com"
    }
  ],
  "homepage": "https://example-vincent-homepage.com",
  "status": "valid",
  "ipfsCid": "QmdoY1VUxVvxShBQK5B6PP2jZFVw7PMTJ3qy2aiCARjMqo",
  "parameters": {
    "uiSchema": "{\"type\":\"object\",\"properties\":{}}",
    "jsonSchema": "{\"type\":\"object\",\"required\":[],\"properties\":{}}"
  }
}

Changes