List API Package Documents
Returns a collection of all documents for an API package.
Query Parameters
Filters API Documents in the response.
Show Child Parameters
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
List of API Package documents
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Get an API Package Document
Returns a document for the 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
application/json
Response
API Package 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
Update API Package Document
Updates a document for 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
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 Package 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 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.