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

Authorizations

Authorization
string
headerrequired

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

Path Parameters

organisationId
string
required

OrganisationID is the ID of the organisation that the schema belongs to.

appId
string
required

AppId is the app identifier

Body

application/json
callbacks
object

The callbacks of the operation.

components
object

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

description
string

A human-friendly description of what this operation does.

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
name
string

A human-friendly name based on the operation ID.

path
string

The path used to call the operation.

request
object
response
object

The response body of the operation.

schemaId
string
required

The ID of the schema this object belongs to.

Response

200 - application/json
callbacks
object

The callbacks of the operation.

components
object

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

description
string

A human-friendly description of what this operation does.

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
name
string

A human-friendly name based on the operation ID.

path
string

The path used to call the operation.

request
object
response
object

The response body of the operation.

schemaId
string
required

The ID of the schema this object belongs to.