Update API Document
Updates a document for an API.
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
API Document
Raw markdown content to display in your Portal
The title of the document. Used to populate the <title> tag for the page
Example:API Document
The slug is used in generated URLs to provide human readable paths.
Defaults to slugify(title)
Match pattern:^[\w-]+$
Example:api-document
If status=published the document will be visible in your live portal
Allowed values:publishedunpublished
Default:unpublished
API Documents may be rendered as a tree of files.
Specify the id of another API Document as the parent_document_id to add some heirarchy do your documents.
Example:null
Response
application/json
Response
API document
API Document
The API document identifier.
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
Raw markdown content to display in your Portal
The title of the document. Used to populate the <title> tag for the page
Example:API Document
The slug is used in generated URLs to provide human readable paths.
Defaults to slugify(title)
Match pattern:^[\w-]+$
Example:api-document
If status=published the document will be visible in your live portal
Allowed values:publishedunpublished
Default:unpublished
API Documents may be rendered as a tree of files.
Specify the id of another API Document as the parent_document_id to add some heirarchy do your documents.
Example:null
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
Delete API Documentation
Removes a document from an API.
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
Response
Response
Document for the API was deleted successfully.
Authentication
Path Parameters
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.