API Document Title
stringThe title of the document. Used to populate the <title> tag for the page
ApiDocumentStatus
stringIf status=published the document will be visible in your live portal
Allowed values:publishedunpublished
Default:unpublished
API Document Parent Document ID
stringAPI 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.
API Document Slug
stringThe slug is used in generated URLs to provide human readable paths.
Defaults to slugify(title)
Match pattern:^[\w-]+$
API Document Summary
objectThe API document identifier.
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
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.
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