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 type markdown/html distinguishes documentation from API references.

Sample Request

 🚧 Important: The source property internal/external determines if it's possible to edit document's content only via API (external) or in the UI (internal). The default value is internal.

For documents managed via API flows you can prevent edits in the UI by setting source to external

Sample Response

Add Contents

Use the PATCH Update the contents of a document endpoint to provide actual content.

After documentation and API reference are added, the portal may look like:

Sample Portal Product Documentation

 

Sample Portal Product API Reference

Nest Pages

Nesting allows you to nest pages 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/{tableOfContentsId} endpoint:

MethodParameterDescription
PATCHparentIdIndicates parent page. If null, page is root-level.
PATCHorder (nullable)
The order of the item in the table of contents, starting from 0.
If explicitly set to null, the item will be moved to the end of the list.
PATCHslug
The URL slug.
PATCHtitle
The title of the table of contents.
DELETErecursiveDeletes nested subpages if set to true.

Sample Request to Add Subpage

Sample Response