POST
/
organisations
/
{organisationId}
/
schema-utils
/
{schemaType}
/
source-url
cURL
curl --request POST \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schema-utils/{schemaType}/source-url \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sourceURL": "<string>",
  "additionalHeaders": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}'
{
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organisationId
string
required
​
schemaType
string
required

SchemaType is the type of schema which an App implements. The only supported values are currently "openapi", but is planned to be extended to include gRPC, GraphQL and SOAP.

Body

application/json

UploadSchemaFromURLRequest contains the necessary parameters to upload a schema object from a source URL.

​
sourceURL
string
required

SourceURL is the URL which can be used to download the original schema document.

​
additionalHeaders
object[]

Response

UploadSchemaFromURLResponse contains a URL which can be used to download an uploaded schema from object storage.

​
url
string
required

The URL to identify the schema. This is not publicly accessible and is to be used when creating an App.