Docs

Use these operations to interact with external docs on entities in Cortex.

Required permissions

Your API key must have the Edit entities permission.

Operations

Retrieve OpenAPI docs for entity

get

Authorizations

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Query parameters

namestringOptional

Name of the OpenAPI spec to return. If you have multiple OpenAPI specs configured for your entity as x-cortex-links, use this parameter to ensure the correct spec is returned. If this parameter is not specified, we will return the first OpenAPI spec found.

Responses

200

Successfully found documentation

application/json

specstringRequired

Stringified JSON representation of the OpenAPI spec

404

Documentation not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get/api/v1/catalog/{tagOrId}/documentation/openapi

GET /api/v1/catalog/{tagOrId}/documentation/openapi HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "spec": "text"
}

Update OpenAPI docs for entity

put

Authorizations

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

specstringRequired

Stringified JSON representation of the OpenAPI spec

Responses

200

Successfully updated documentation

application/json

specstringRequired

Stringified JSON representation of the OpenAPI spec

400

Invalid request

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put/api/v1/catalog/{tagOrId}/documentation/openapi

PUT /api/v1/catalog/{tagOrId}/documentation/openapi HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "spec": "text"
}

{
  "spec": "text"
}

Delete OpenAPI docs for entity

delete

Authorizations

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Responses

204

Successfully deleted documentation

No content

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete/api/v1/catalog/{tagOrId}/documentation/openapi

DELETE /api/v1/catalog/{tagOrId}/documentation/openapi HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content