GET
/
organisations
/
{organisationId}
/
apps
/
{appId}
/
operations
/
{operationId}
/
schema
curl --request GET \
  --url https://api.switchboard.svc.versori.io/v1alpha1/organisations/{organisationId}/apps/{appId}/operations/{operationId}/schema \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "method": "GET",
  "description": "<string>",
  "name": "<string>",
  "schemaId": "<string>",
  "path": "<string>",
  "request": {
    "parameters": [
      {
        "name": "<string>",
        "type": "string",
        "location": "path"
      }
    ],
    "body": {}
  },
  "response": {},
  "callbacks": {},
  "components": {}
}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

organisationId
string
required
appId
string
required
operationId
string
required

Response

200 - application/json
id
string

The ID of the operation, for OpenAPI this will be the operationId field if set, otherwise the request's type and path.

method
enum<string>

The http method that the operation uses.

Available options:
GET,
PUT,
POST,
DELETE,
OPTIONS,
HEAD,
PATCH,
TRACE,
SQL
description
string

A human-friendly description of what this operation does.

name
string

A human-friendly name based on the operation ID.

schemaId
string
required

The ID of the schema this object belongs to.

path
string

The path used to call the operation.

request
object
response
object

The response body of the operation.

callbacks
object

The callbacks of the operation.

components
object

An optional map of components the operation refers to indexed by ref.