API Document ID

string

The API document identifier.

Example

API Document Content

string

Raw markdown content to display in your Portal

API Document Title

string

The title of the document. Used to populate the <title> tag for the page

Example

ApiDocumentStatus

string

If status=published the document will be visible in your live portal

Allowed values:publishedunpublished

Default:unpublished

API Document Parent Document ID

string

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.