POST
/
organisations
/
{organisationId}
/
schema-utils
/
{schemaType}
/
info
cURL
curl --request POST \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schema-utils/{schemaType}/info \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sourceURL": "<string>"
}'
{
  "id": "<string>",
  "title": "<string>",
  "availableServers": [
    {
      "name": "<string>",
      "url": "<string>"
    }
  ],
  "schemaMetadata": {
    "type": "<string>",
    "version": "<string>",
    "url": "<string>"
  },
  "supportedAuthConfigs": [
    {
      "type": "<string>",
      "isValid": true,
      "data": {
        "discoveryUrl": "<string>",
        "clientId": "<string>",
        "clientSecret": "<string>",
        "scopes": {}
      }
    }
  ]
}

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

GetSchemaInfoRequest contains the necessary parameters to retrieve schema info.

​
sourceURL
string
required

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

Response

200
application/json

SchemaInfoResponse is the response containing the SchemaInfo of a schema.

​
availableServers
object[]
required
​
schemaMetadata
object
required
​
supportedAuthConfigs
object[]
required

SupportedAuthConfigs is a list of authentication standards which can be used to connect a user's account to this app. At least one auth type needs to be valid for the App to be used by a user.

​
id
string

The ID of the Schema record if it is stored.

​
title
string

Title is calculated from the parsed schema. Not all schemas contain this information so may be null.