Create a new new connector version.
ImportHTTPConnectorVersion is used to create a new version for the connector.
This uses a new OpenAPI spec to create the new version.
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.
Body
The file to be imported.
ImportHTTPConnectorVersionMetadata defines the metadata part of the multipart/form-data request when creating a new connector version.
The format of the file to be imported.
openapi
- OpenAPI 3.x specification, we may include support for 2.x in the future.
openapi
Name of the the version to create.
Response
ImportHTTPConnectorResult defines the result of importing a Connector from an external format, such as OpenAPI.
HTTPConnector represents a connector to an external system over HTTP.
ID is the unique identifier of the Connector.
OrganisationID is the unique identifier of the Organisation that owns the Connector.
Name is the user-provided name of the Connector
ProtocolType denotes the set of all valid connector types.
http
, bigquery
Connections is a list of all the connections this Connector has.
Versions is a list of all the versions this Connector has.
CreatedAt is the time at which the ConnectorVersion was created.
UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child resources.
BaseURL is the base URL of all HTTP Actions within the Connector.
Hold an optional link to the documentation for the API.
The URL for the icon for the connector
Connection Variables is a list of default variables initialised in every connector connection.
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.
ID is the unique identifier of the Action.
Errors is a list of ErrorField objects which defines the errors which may be returned by the Action. An empty array denotes that the Action has been validated and no errors were found. If this field is undefined then this means validation has not occurred.
http
Name is a unique identifier for the Action within the scope of the Connector. It is expected to both human and machine-readable, i.e. "GetProduct" or "get_products", see the validation regex for more details.
Summary is a human-readable version of the id
field, i.e. "Get Product" or "Get Products". This is used
when displaying the Action to users, however if omitted the actionId
can be used to display to users
instead.
Description is a human-readable description of the Action. It can provide extra information to users about how the Action operates and anything the user may need to be aware of when using it.
HTTPMethod defines the HTTP method which will be used when invoking the Action. This is typically one of the standard HTTP methods such as GET, POST, PUT, PATCH or DELETE, but may be any valid HTTP method.
GET
, POST
, PUT
, PATCH
, DELETE
, HEAD
, OPTIONS
, CONNECT
, TRACE
ActionPath is appended to the Connector's base URL to build the full URL to send requests to. It may also contain placeholders to inject dynamic values from the following sources:
{{ param.<name> }}
- Injects the value of the parameter with the given name.{{ conn.<name> }}
- Injects the value of the connection variable with the given name.
ActionHTTPRequestBody defines whether a request body is required for a particular HTTP Action, and if so which Definitions are considered valid. If this value is undefined then no request body will be sent.
Responses defines the expected responses from the HTTP endpoint. This is used to determine whether the Action was successful or not.
ID is the unique identifier of the Trigger.
Errors is a list of ErrorField objects which defines the errors which may be returned by the Trigger. An empty array denotes that the Trigger has been validated and no errors were found. If this field is undefined then this means validation has not occurred.
http
Name is a unique identifier for the Trigger within the scope of the Connector. It is expected to both human and machine-readable, i.e. "GetProduct" or "get_products", see the validation regex for more details.
Summary is a human-readable version of the id
field, i.e. "Get Product" or "Get Products". This is used
when displaying the Trigger to users, however if omitted the TriggerId
can be used to display to users
instead.
Description is a human-readable description of the Trigger. It can provide extra information to users about how the Trigger operates and anything the user may need to be aware of when using it.
HTTPMethod defines the HTTP method which will be used when invoking the Action. This is typically one of the standard HTTP methods such as GET, POST, PUT, PATCH or DELETE, but may be any valid HTTP method.
GET
, POST
, PUT
, PATCH
, DELETE
, HEAD
, OPTIONS
, CONNECT
, TRACE
TriggerHTTPRequestBody defines whether a request body is required for a particular HTTP Trigger, and if so which Definitions are considered valid. If this value is undefined then no request body will be sent.
Responses defines the expected responses from the HTTP endpoint. This is used to determine whether the Trigger was successful or not.
Text contains the text of the message.
info
, warning
, error
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.