Skip to content

Commit 29b603b

Browse files
chore: updated doc
1 parent d9d67d0 commit 29b603b

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/products/SmartBear MCP Server/swagger-portal-integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ The Swagger Portal client provides comprehensive portal and product management c
123123
- `previewUrl` (string, conditional): Generated preview URL (only when preview is true)
124124
- `product` (object): Product metadata with fields: `id`, `name`, `slug`
125125
- `portal` (object): Portal metadata with fields: `id`, `name`, `subdomain`, `customDomain`
126-
- `tableOfContentsItem` (object | null): Table of contents metadata with fields: `id`, `slug`, `title`, `order`, `parentId` (null when tableOfContentsId is not provided or not found)
126+
- `tableOfContentsItem` Optional (object): Table of contents metadata with fields: `id`, `slug`, `title`, `order`, `parentId` (null when tableOfContentsId is not provided or not found)
127127
- Use case: Make product content visible to portal visitors, either as live content or preview for testing.
128128
- Parameters:
129129

@@ -137,7 +137,7 @@ The Swagger Portal client provides comprehensive portal and product management c
137137
- When `portal.customDomain` is present, it is used as the full host in the generated URL without appending the portal UI suffix
138138
- When `customDomain` is not present, the URL is built using `portal.subdomain` + the portal UI suffix (`.portal.swaggerhub.com`)
139139
- When `tableOfContentsId` resolves successfully, the returned URL includes the section and table-of-contents path in the format: `/{productSlug}/{sectionSlug}/{tocSlug}`
140-
- The response includes only essential fields from product, portal, and tableOfContentsItem following React/TypeScript best practices using Pick<> utility types
140+
- The response includes only essential fields from product, portal, and tableOfContentsItem.
141141

142142
### Product Sections Management
143143

0 commit comments

Comments
 (0)