Update Definition
UpdateDefinition updates the specified Definition with the request body.
Authorizations
Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.
Path Parameters
ID is the unique identifier of the Connector.
Version is the version name of the Connector to retrieve. The reserved names "latest" and "default" may be used to retrieve the latest version or the default version respectively.
Body
DefinitionUpdate is the payload used to update an existing Definition.
ID is the unique identifier of the Definition. This must be set for updates.
Name is a unique identifier for the Definition within the scope of the Connector. It is expected to both human and machine-readable, i.e. "Product" or "product_variant".
Accept indicates which content types, expressed as MIME types, that this definition can accept. This value is analogous to the Accept HTTP header, as defined in RFC 7231, section 5.3.2, except each type is defined in a separate array element, rather than as a comma-separated list.
This does not represent the content type of the schema body itself, but the data which conforms to this
definition. For example, an API may respond in JSON or YAML, but the schema may be a YAML-formatted JSON
Schema. In this case, the Definition's accept field could be ["application/json", "text/yaml"] and
schema.contentType will be application/schema+yaml.
Description is a human-friendly description of the Definition. This is typically used to describe the purpose of the Definition and how it should be used.
InlineSchema is a Schema which is defined inline within the Definition. This is typically used when creating or updating a Definition and the actual schema payload is sent with the request. For retrieval operations, the Definition will contain a URL which resolves to the Schema.
ContentType is the MIME type of the Schema, i.e. application/schema+json or application/schema+yaml etc. This should not be confused with the media type of the data which conforms to the Schema.
The ContentType may also include parameters as would be appropriate for the content, consumers and producers should be prepared to handle this, i.e. "application/schema+json; charset=utf-8".
Schema is the actual schema definition. This is typically a JSON Schema, however other formats are supported such as XML Schema.
Response
Definition describes a single definition of a type which is used by the Connector. The schema language used is dependent on the media-type of the Definition, for example JSON Schema is used for media-types application/json.
ID is the unique identifier of the Definition.
Name is a unique identifier for the Definition within the scope of the Connector. It is expected to both human and machine-readable, i.e. "Product" or "product_variant".
Accept indicates which content types, expressed as MIME types, that this definition can accept. This value is analogous to the Accept HTTP header, as defined in RFC 7231, section 5.3.2, except each type is defined in a separate array element, rather than as a comma-separated list.
This does not represent the content type of the schema body itself, but the data which conforms to this
definition. For example, an API may respond in JSON or YAML, but the schema may be a YAML-formatted JSON
Schema. In this case, the Definition's accept field could be ["application/json", "text/yaml"] and
schema.contentType will be application/schema+yaml.
Description is a human-friendly description of the Definition. This is typically used to describe the purpose of the Definition and how it should be used.
URL is the location of the actual Schema definition for this Definition entity.
The structure of this URL will be consistent across all media types for each connection, for example:
https://platform.versori.com/api/schemas/v1/o/{organisation_id}/{connector_id}/{connector_version}/{definition_slug}.{media_type_ext}
ReferencedBy is a list of DefinitionReference objects which defines what other entities are referencing the this Definition.
definition, action, trigger ID is the unique identifier of the Definition/Action/Trigger.
Name is unique identifier for the Definition/Action/Trigger within the scope of the Connector. It is expected to both human and machine-readable, i.e. "ProductFeature" or "stock_item".