POST
/
organisations
/
{organisationId}
/
schema-utils
/
{schemaType}
/
info
curl --request POST \
  --url https://api.switchboard.svc.versori.io/v1alpha1/organisations/{organisationId}/schema-utils/{schemaType}/info \
  --header 'Authorization: Bearer <token>' \
  --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
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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
sourceURL
string
required

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

Response

200 - application/json
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.

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.