Add Docs to Product
Additional documentation (Markdown or HTML) can be added to enhance the user’s understanding and experience of API products. These documents are added as table-of-contents entries.
Use the POST Add table of contents entry endpoint to link a Markdown document.
📌 The
content
typemarkdown
distinguishes documentation from API references.
Sample Request
Sample Response
Add Markdown Contents
Use the PATCH Update the contents of a document endpoint to provide actual Markdown content.
After documentation and API reference are added, the portal may look like:
Nest Pages
Nesting allows you to nest pages (but not APIs) for better content structure. Use the parentId
field in the request payload to create subpages.
The following parameters are used with the /table-of-contents/{id}
endpoint:
Method | Parameter | Description |
---|---|---|
GET | children | Includes subpages. |
POST, PATCH | parentId | Indicates parent page. If null, page is root-level. |
DELETE | recursive | Deletes nested subpages if set to true. |