Patch the schema for the project's dynamic variables

PatchProjectVariablesSchema patches the JSON schema for the project’s dynamic variables. This allows you to add, remove or edit the schema for the project’s dynamic variables.

PATCH /o/{organisation_id}/projects/{project_id}/variables

Try it

Patch the schema for the project's dynamic variables

cURL

curl --request PATCH \
  --url https://platform.versori.com/api/v2/o/{organisation_id}/projects/{project_id}/variables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "op": "add",
  "path": "<string>",
  "value": {}
}
'

200

{}

Authorizations

Authorization · string · header · required

Bearer token authentication used by the Versori Platform. You must provide a signed JWT provided by our IdP.

Path Parameters

organisation_id · string<ulid> · required

project_id · string<ulid> · required

Body

application/json

DynamicVariablesSchemaPatch is the request body for updating the project's dynamic variables.

op · enum<string> · required

Available options: add, remove, replace

path · string · required

The path to the field to update. This should be a JSON path to the field to update. For example, if you want to update/remove the dynamic variables newVar in the following schema:

{
  "type": "object",
  "properties": {
    "newVar": {
      "type": "string"
    }
  }
}

The path would be /properties/newVar.

value · object

The value to set the field to. This should be valid JSON schema containing the name of the variable, its type and any other properties. An example would be {"newVar": {"type": "string"}}.

Response

200

application/json

OK

DynamicVariablesSchema is the JSON schema for the project's dynamic variables.