Move API Documentation
This api allows the user to move a document within the document tree using the parameters parent_document_id and index. If parent_document_id is not provided, the document will be placed at the top level of the document tree. index represents a zero-indexed document order relative to its siblings under the same parent. For example, if we want to put the document at top level in first position we would send parent_document_id: null and index: 0. This api also supports using a negative index to count backwards from the end of the document list, which means you can put the document in last position by using index: -1.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The document identifier related to the API
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
Body
application/json
Body
move document
Move document
move document request payload
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
index of the document in the parent document’s children
Example:1
Response
Response
Document for the API was moved successfully.
Authentication
Path Parameters
Body
API Specification
Validate API Specification
Validates the content and type (OpenAPI or AsyncAPI) of a potential API specification without associating it with a specific API.
Body
application/json
Body
Specification content and type for validation.
API Specification Validation Request Payload
The raw content of your API specification (OpenAPI or AsyncAPI), in json or yaml, to be validated.
Response
application/json
Response
API specification (OpenAPI or AsyncAPI) validation successful
API Specification Validation Success Response
Any informational messages or warnings generated during validation. Empty if none.
Show Child Parameters
Authentication
Body
Create API Specification
DEPRECATEDCreates a specification (OpenAPI or AsyncAPI) for an API.
Note: You can only have one specification for an API. This endpoint is deprecated and will be removed: use /versions instead.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Body
application/json
Body
API Specification
The raw content of your API specification, in json or yaml format (OpenAPI or AsyncAPI).
Example:{"openapi":"3.0.3","info":{"title":"Example API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example endpoint","responses":{"200":{"description":"Successful response"}}}}}}
The type of specification being stored. This allows us to render the specification correctly.
Allowed values:oas2oas3asyncapi
Example:oas3
Response
application/json
Response
API specification (OpenAPI or AsyncAPI)
API Specification
The API specification identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
The raw content of your API specification, in json or yaml format (OpenAPI or AsyncAPI).
Example:{"openapi":"3.0.3","info":{"title":"Example API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example endpoint","responses":{"200":{"description":"Successful response"}}}}}}
The errors that occurred while parsing the API specification.
Show Child Parameters
The type of specification being stored. This allows us to render the specification correctly.
Allowed values:oas2oas3asyncapi
Example:oas3
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
List API Specifications
DEPRECATEDReturns a list of specifications for an API. The specification can be of type OpenAPI or AsyncAPI.
Note: You can only have one specification for an API. This endpoint is deprecated and will be removed: use /versions instead.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters API Specs in the response.
Show Child Parameters
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
List of API specifications (OpenAPI or AsyncAPI)
ListApiSpecResponse
returns the pagination information