You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/products/SmartBear MCP Server/swagger-portal-integration.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,7 +123,7 @@ The Swagger Portal client provides comprehensive portal and product management c
123
123
-`previewUrl` (string, conditional): Generated preview URL (only when preview is true)
124
124
-`product` (object): Product metadata with fields: `id`, `name`, `slug`
125
125
-`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)
127
127
- Use case: Make product content visible to portal visitors, either as live content or preview for testing.
128
128
- Parameters:
129
129
@@ -137,7 +137,7 @@ The Swagger Portal client provides comprehensive portal and product management c
137
137
- When `portal.customDomain` is present, it is used as the full host in the generated URL without appending the portal UI suffix
138
138
- When `customDomain` is not present, the URL is built using `portal.subdomain` + the portal UI suffix (`.portal.swaggerhub.com`)
139
139
- 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.
0 commit comments