LIlit-protocol
PolicyVersion

Edits a policy version

Changed on
put/policy/{packageName}/version/{version}

Request

  • Base URL
    https://api.heyvincent.ai
  • URL
    https://api.heyvincent.ai/policy/{packageName}/version/{version}
  • Auth
    API key in header Authorization

Path parameters

packageNamestring required

The NPM package name

versionstring required

NPM semver of the target policy version

Request body

changesstring required

Changelog information for this version

Example request

{
  "changes": "Resolved issue with checking for spending limits on the wrong chain."
}

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 NPM package name

versionstring required

Policy version - must be an exact semver

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

ipfsCidstring required

IPFS CID of the code that implements this policy.

isDeletedboolean

Whether or not this PolicyVersion is deleted

Example response

{
  "packageName": "@lit-protocol/vincent-policy-spending-limit",
  "version": "1.0.0",
  "changes": "Resolved issue with checking for spending limits on the wrong chain.",
  "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",
  "ipfsCid": "QmdoY1VUxVvxShBQK5B6PP2jZFVw7PMTJ3qy2aiCARjMqo",
  "parameters": {
    "uiSchema": "{\"type\":\"object\",\"properties\":{}}",
    "jsonSchema": "{\"type\":\"object\",\"required\":[],\"properties\":{}}"
  }
}

Changes

  • 3a57afc3e1f4Revision changes
    • info

      the endpoint scheme security siweAuth was added to the API

    • info

      the endpoint scheme security bearerAuth was removed from the API

  • 246a15ffe975Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security siweAuth was removed from the API