PUT
/
o
/
{organisation_id}
/
connectors
/
{connector_id}
/
versions
/
{version}

Authorizations

Authorization
string
headerrequired

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

organisation_id
string
required
connector_id
string
required

ID is the unique identifier of the Connector.

version
string
required

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

application/json

ConnectorVersion represents a version of a Connector.

id
string
required

ID is the unique identifier of the ConnectorVersion, this is typically only used internally and the version name is used externally in combination with the Connector id.

name
string
required

Name denotes the actual version value for the Connector. This can be any value but a consistent naming strategy is recommended, such as SemVer, CalVer or an incrementing number. The names "default" and "latest" are reserved words and cannot be used.

description
string

Description allows specifying additional information about the ConnectorVersion, such as what changed since the last version etc.

isLatest
boolean
required

IsLatest denotes whether this is the latest version of the Connector.

isDefault
boolean
required

IsDefault denotes whether this is the default version of the Connector.

createdAt
string
required

CreatedAt is the time at which the ConnectorVersion was created.

updatedAt
string
required

UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child resources.

publishedAt
string | null
required

PublishedAt is the time at which the ConnectorVersion was published.

messages
object[]
messages.text
string
required

Text contains the text of the message.

messages.severity
enum<string>
required
Available options:
info,
warning,
error
messages.detail
string[]

Details contains additional information about the message. This is intended to be used to provide more information about the message, such as a list of validation errors.

Response

200 - application/json

ConnectorVersion represents a version of a Connector.

id
string
required

ID is the unique identifier of the ConnectorVersion, this is typically only used internally and the version name is used externally in combination with the Connector id.

name
string
required

Name denotes the actual version value for the Connector. This can be any value but a consistent naming strategy is recommended, such as SemVer, CalVer or an incrementing number. The names "default" and "latest" are reserved words and cannot be used.

description
string

Description allows specifying additional information about the ConnectorVersion, such as what changed since the last version etc.

isLatest
boolean
required

IsLatest denotes whether this is the latest version of the Connector.

isDefault
boolean
required

IsDefault denotes whether this is the default version of the Connector.

createdAt
string
required

CreatedAt is the time at which the ConnectorVersion was created.

updatedAt
string
required

UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child resources.

publishedAt
string | null
required

PublishedAt is the time at which the ConnectorVersion was published.

messages
object[]
messages.text
string
required

Text contains the text of the message.

messages.severity
enum<string>
required
Available options:
info,
warning,
error
messages.detail
string[]

Details contains additional information about the message. This is intended to be used to provide more information about the message, such as a list of validation errors.