Swagger: Create Documentation Page
swagger_create_documentation_pageCreate a documentation page in a SmartBear portal product with markdown or HTML content, returning page location and draft URL for editing.
Instructions
Create a documentation page in a portal product in a single tool call. Supports markdown and html content types. Returns the page location details (productId, sectionId, slug) and a draftUrl to edit it in the portal.
Toolset: Documents
Parameters:
portalId (string) required: Portal UUID or subdomain - unique identifier for the portal
productId (string) required: Product UUID - unique identifier for the product
pageTitle (string) required: Title of the documentation page - will be displayed in navigation (3-255 characters)
pageSlug (string): URL slug for the documentation page. 3-255 characters, lowercase, alphanumeric with hyphens, underscores, or dots (e.g. 'my-page'). If not provided, the slug is generated from the page title.
pageContent (string): Content of the documentation page. Provide HTML when contentType is 'html', Markdown when contentType is 'markdown'.
contentType (enum): Content type of the documentation page. 'markdown' works with both 'internal' and 'external' source. 'html' only works with 'external' source — html + internal is not supported by the API and will return an error. (default: "markdown")
source (enum): Where the document content is managed. 'internal': editable in both the portal UI and via API. 'external': editable via API only, not in the portal UI. Constraint: 'html' content type only supports 'external' source. (default: "internal")
order (number): Order position of the documentation page within its parent section or item (default: 0)
parentId (string): Parent table of contents item ID - null for top-level pages, or ID of parent item for nested structure
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| order | No | Order position of the documentation page within its parent section or item | |
| source | No | Where the document content is managed. 'internal': editable in both the portal UI and via API. 'external': editable via API only, not in the portal UI. Constraint: 'html' content type only supports 'external' source. | internal |
| pageSlug | No | URL slug for the documentation page. 3-255 characters, lowercase, alphanumeric with hyphens, underscores, or dots (e.g. 'my-page'). If not provided, the slug is generated from the page title. | |
| parentId | No | Parent table of contents item ID - null for top-level pages, or ID of parent item for nested structure | |
| portalId | Yes | Portal UUID or subdomain - unique identifier for the portal | |
| pageTitle | Yes | Title of the documentation page - will be displayed in navigation (3-255 characters) | |
| productId | Yes | Product UUID - unique identifier for the product | |
| contentType | No | Content type of the documentation page. 'markdown' works with both 'internal' and 'external' source. 'html' only works with 'external' source — html + internal is not supported by the API and will return an error. | markdown |
| pageContent | No | Content of the documentation page. Provide HTML when contentType is 'html', Markdown when contentType is 'markdown'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| draftUrl | No | ||
| productId | No | ||
| sectionId | No | ||
| sectionSlug | No |