Delete API Package Documentation
Removes a document from an API Package.
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The document identifier related to the API
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
Response
Response
Document for the API was deleted successfully.
Authentication
Path Parameters
Move API Package 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 Package 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 Package was moved successfully.
Authentication
Path Parameters
Body
Create API Version
Creates a version (OpenAPI or AsyncAPI) for an API.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Body
application/json
Body
API Version
The version of the api.
Example:1.0.0
Show Child Parameters
Response
application/json
Response
API version (OpenAPI or AsyncAPI)
API Version
The API version identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
The version of the api.
Example:1.0.0
Show Child Parameters
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 Versions
Returns a list of versions for an API. The version can be of type OpenAPI or AsyncAPI.
Note: You can only have one version for an API.
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 Version in the response.
Show Child Parameters
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
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
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Get an API Version
Fetches the version (OpenAPI or AsyncAPI) of an API.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The API version identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
API version (OpenAPI or AsyncAPI)
API Version
The API version identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
The version of the api.
Example:1.0.0
Show Child Parameters
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