chore: added preview url and live url

Author: VarshaNagtilak1

CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- [Swagger] Refactored `publish_portal_product` to build live URLs dynamically from `SWAGGER_PORTAL_BASE_PATH`, support preview and section/table-of-contents paths, and return the resolved `liveUrl` in the publish response.
+- [Swagger] Refactored `publish_portal_product` to build published URLs dynamically from `SWAGGER_PORTAL_BASE_PATH`, support preview and section/table-of-contents paths, and return the resolved `liveUrl` or `previewUrl` in the publish response.
 
 ### Added
 

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

@@ -116,7 +116,7 @@ The Swagger Portal client provides comprehensive portal and product management c
 #### `publish_portal_product`
 
 - Purpose: Publish a product's content to make it live or as preview. This endpoint publishes the current content of a product, making it visible to portal visitors. Use preview mode to test before going live.
-- Returns: Publication status information, including the generated live URL when the product can be resolved.
+- Returns: Publication status information, including the generated `liveUrl` for live publication or `previewUrl` for preview publication when the product can be resolved.
 - Use case: Make product content visible to portal visitors, either as live content or preview for testing.
 - Parameters:
 
@@ -126,7 +126,7 @@ The Swagger Portal client provides comprehensive portal and product management c
 | `preview`   | Whether to publish as preview (true) or live (false). Preview allows testing before going live. Defaults to false (live publication) | boolean | No       |
 | `tableOfContentsId` | Optional table of contents UUID, or identifier in the format 'portal-subdomain:product-slug:section-slug:table-of-contents-slug' used to resolve a specific live URL path | string | No |
 
-The publish response now includes `liveUrl` when available. The live URL is built dynamically from the configured `portalBasePath`, so it works across dev2, int, and production environments.
+The publish response now includes `liveUrl` for live publication and `previewUrl` for preview publication. The URL is built dynamically from the configured `portalBasePath`, so it works across dev2, int, and production environments. When `tableOfContentsId` resolves, the returned URL includes the section and table-of-contents path.
 
 ### Product Sections Management
 

src/swagger/client/api.ts

@@ -361,11 +361,12 @@ export class SwaggerAPI {
   }
 
   /**
-   * Publish a portal product and generate live URL with environment-specific domain
+   * Publish a portal product and generate a published URL with environment-specific domain.
+   * Returns `liveUrl` for live publishes and `previewUrl` for preview publishes.
    * @param productId - ID of the product to publish
    * @param preview - Whether to publish in preview mode (default: false)
-   * @param tableOfContentsId - Optional tableOfContentsId The table of contents UUID, or identifier in the format 'portal-subdomain:product-slug:section-slug:table-of-contents-slug'
-   * @returns Complete publish response with product details and live URL
+   * @param tableOfContentsId - Optional table of contents UUID, or identifier in the format 'portal-subdomain:product-slug:section-slug:table-of-contents-slug'
+   * @returns Complete publish response with product details and the resolved published URL
    */
   async publishPortalProduct(
     productId: string,
@@ -399,12 +400,13 @@ export class SwaggerAPI {
 
     // Build live URL using environment-specific domain
     const host = portalDetails.customDomain ?? portalDetails.subdomain;
-    const liveUrl = buildPortalLiveUrl(
+    const publicationUrl = buildPortalLiveUrl(
       this.config,
       host,
       productDetails.slug,
       targetSection,
       targetTocItem,
+      preview,
     );
 
     // Publish the product to the portal
@@ -422,7 +424,9 @@ export class SwaggerAPI {
 
     return {
       ...result,
-      liveUrl,
+      ...(preview
+        ? { previewUrl: publicationUrl }
+        : { liveUrl: publicationUrl }),
     } as PublishPortalProductResponse;
   }
 

src/swagger/client/portal-types.ts

@@ -432,6 +432,7 @@ export type UpdateDocumentBody = Omit<UpdateDocumentArgs, "documentId">;
 
 export type PublishPortalProductResponse = SuccessResponse & {
   liveUrl?: string;
+  previewUrl?: string;
 };
 
 // Response types for better type safety

src/swagger/client/utils.ts

@@ -26,25 +26,27 @@ export function findTableOfContentsItem(
 }
 
 /**
- * Build the live URL for a published portal product.
+ * Build the live URL or previewUrl for a published portal product.
  */
 export function buildPortalLiveUrl(
   config: SwaggerConfiguration,
   host: string | undefined,
   productSlug: string | undefined,
   section: UrlSegmentSource,
   tocItem: UrlSegmentSource,
+  preview: boolean = false,
 ): string {
   if (!host || !productSlug) {
     return "";
   }
 
   const portalUiDomain = config.getPortalUiDomainSuffix();
   const baseUrl = `https://${host}${portalUiDomain}/${productSlug}`;
+  const previewSuffix = preview ? "?preview=product" : "";
 
   if (section?.slug && tocItem?.slug) {
-    return `${baseUrl}/${section.slug}/${tocItem.slug}`;
+    return `${baseUrl}/${section.slug}/${tocItem.slug}${previewSuffix}`;
   }
 
-  return baseUrl;
+  return `${baseUrl}${previewSuffix}`;
 }

src/tests/unit/swagger/api.test.ts

@@ -243,59 +243,73 @@ describe("SwaggerAPI", () => {
   });
 
   describe("publishPortalProduct", () => {
-    it("should publish product and return resolved liveUrl", async () => {
-      const headers = {
-        Authorization: "Bearer test-token",
-        "Content-Type": "application/json",
-        "User-Agent": "SmartBear-MCP/1.0.0",
-      };
-      const productId = "prod-123";
-      const portalId = "portal-123";
-      const productSlug = "test-product";
-      const tocId = "toc-1";
-
-      const productResponse = {
-        id: productId,
-        name: "Test Product",
-        slug: productSlug,
-        portalId,
-      };
-      const portalResponse = {
-        id: portalId,
-        name: "Test Portal",
-        subdomain: "testportal",
-      };
-      const sectionsResponse = {
-        page: {
-          number: 0,
-          size: 20,
-          totalElements: 1,
-          totalPages: 1,
+    const headers = {
+      Authorization: "Bearer test-token",
+      "Content-Type": "application/json",
+      "User-Agent": "SmartBear-MCP/1.0.0",
+    };
+
+    const productId = "prod-123";
+    const portalId = "portal-123";
+    const productSlug = "test-product";
+    const tocId = "toc-1";
+
+    const productResponse = {
+      id: productId,
+      name: "Test Product",
+      slug: productSlug,
+      portalId,
+    };
+
+    const portalResponse = {
+      id: portalId,
+      name: "Test Portal",
+      subdomain: "testportal",
+    };
+
+    const sectionsResponse = {
+      page: {
+        number: 0,
+        size: 20,
+        totalElements: 1,
+        totalPages: 1,
+      },
+      items: [
+        {
+          id: "section-1",
+          productId,
+          title: "Docs",
+          slug: "docs",
+          tableOfContents: [
+            {
+              id: tocId,
+              slug: "getting-started",
+              title: "Getting Started",
+              order: 0,
+              parentId: null,
+              children: [],
+              swaggerhubApi: null,
+              content: null,
+            },
+          ],
+          order: 0,
         },
-        items: [
-          {
-            id: "section-1",
-            productId,
-            title: "Docs",
-            slug: "docs",
-            tableOfContents: [
-              {
-                id: tocId,
-                slug: "getting-started",
-                title: "Getting Started",
-                order: 0,
-                parentId: null,
-                children: [],
-                swaggerhubApi: null,
-                content: null,
-              },
-            ],
-            order: 0,
-          },
-        ],
-      };
-      const publishResponse = { success: true };
+      ],
+    };
+
+    const previewSectionsResponse = {
+      page: {
+        number: 0,
+        size: 20,
+        totalElements: 1,
+        totalPages: 1,
+      },
+      items: [],
+    };
 
+    const publishResponse = { success: true };
+
+    it("should publish product and return resolved liveUrl", async () => {
       fetchMock
         .mockResponseOnce(JSON.stringify(productResponse))
         .mockResponseOnce(JSON.stringify(sectionsResponse))
@@ -343,6 +357,31 @@ describe("SwaggerAPI", () => {
           `https://testportal.portal.swaggerhub.com/${productSlug}/docs/getting-started`,
       });
     });
+
+    it("should publish preview product and return previewUrl", async () => {
+      fetchMock
+        .mockResponseOnce(JSON.stringify(productResponse))
+        .mockResponseOnce(JSON.stringify(previewSectionsResponse))
+        .mockResponseOnce(JSON.stringify(portalResponse))
+        .mockResponseOnce(JSON.stringify(publishResponse));
+
+      const result = await api.publishPortalProduct(productId, true);
+
+      expect(fetchMock).toHaveBeenNthCalledWith(
+        4,
+        `https://api.portal.swaggerhub.com/v1/products/${productId}/published-content?preview=true`,
+        {
+          method: "PUT",
+          headers,
+        },
+      );
+
+      expect(result).toEqual({
+        success: true,
+        previewUrl:
+          `https://testportal.portal.swaggerhub.com/${productSlug}?preview=product`,
+      });
+    });
   });
 
   describe("error handling", () => {