OpenAPI
Manage API documentation that follows the OpenAPI specification.
Authorizations
Path parameters
organizationIdstringrequired
The unique id of the organization
Query parameters
pagestringoptional
Identifier of the page results to fetch.
limitnumber · max: 1000optional
The number of results per page
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
200
default
Authorizations
Path parameters
organizationIdstringrequired
The unique id of the organization
specSlugstringrequired
Slug of the OpenAPI specification
Body
sourceone ofrequired
Create a specification from an URL
Create a specification from a text string
Responses
application/json
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
201
400
default
Authorizations
Path parameters
organizationIdstringrequired
The unique id of the organization
specSlugstringrequired
Slug of the OpenAPI specification
Query parameters
pagestringoptional
Identifier of the page results to fetch.
limitnumber · max: 1000optional
The number of results per page
Responses
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
404
default
Authorizations
Path parameters
organizationIdstringrequired
The unique id of the organization
specSlugstringrequired
Slug of the OpenAPI specification
versionIdstringrequired
The unique ID of the OpenAPI specification version
Responses
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
404
default
Authorizations
Path parameters
organizationIdstringrequired
The unique id of the organization
specSlugstringrequired
Slug of the OpenAPI specification
versionIdstringrequired
The unique ID of the OpenAPI specification version
Responses
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
404
default
Was this helpful?