@mintlify/scraping 4.0.1238 → 4.0.1240

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/scraping",
-  "version": "4.0.1238",
+  "version": "4.0.1240",
   "description": "Scrape documentation frameworks to Mintlify docs",
   "engines": {
     "node": ">=18.0.0"
@@ -43,7 +43,7 @@
     "format:check": "oxfmt --check"
   },
   "dependencies": {
-    "@mintlify/common": "1.0.1356",
+    "@mintlify/common": "1.0.1358",
     "fast-xml-parser": "5.7.3",
     "fs-extra": "11.1.1",
     "graphql": "16.11.0",
@@ -64,7 +64,7 @@
   "devDependencies": {
     "@mintlify/models": "0.0.392",
     "@mintlify/ts-config": "2.0.2",
-    "@mintlify/validation": "0.1.968",
+    "@mintlify/validation": "0.1.969",
     "@tsconfig/recommended": "1.0.2",
     "@types/hast": "3.0.4",
     "@types/mdast": "4.0.4",
@@ -87,5 +87,5 @@
       "optional": true
     }
   },
-  "gitHead": "c04cf8e39c4b17b9c90fe1bf7727ef2526ccb423"
+  "gitHead": "25d1ce0732d16198df5c56261546595074b4c20e"
 }

package/src/openapi/common.ts

@@ -10,12 +10,14 @@ import {
   registerXMintContent,
   prepareStringToBeValidFilename,
   generateUniqueFilenameWithoutExtension,
+  getOperationSlugBase,
   createOpenApiBadgeResolver,
   createOpenApiTagResolver,
   findOpenApiNavGroup,
   isOpenApi32,
   mergePageGroups,
   type LoadedOverlay,
+  type OpenApiSlugSource,
 } from '@mintlify/common';
 import type { DecoratedNavigationPage, PageMetaTags } from '@mintlify/models';
 import { getPathItemOperations, XMint } from '@mintlify/validation';
@@ -144,6 +146,7 @@ export type GenerateOpenApiPagesOptions = {
   resolveBadge?: ReturnType<typeof createOpenApiBadgeResolver>;
   writeFile?: (filename: string, content: string) => void | Promise<void>;
   overlays?: readonly LoadedOverlay[];
+  slug?: OpenApiSlugSource;
 };
 
 export type OpenApiPageGenerationResult<N, DN> = {
@@ -204,9 +207,12 @@ export function processOpenApiPath<N, DN>(
 
     const tagPath = resolveTags(operation?.tags);
     const tagName = tagPath.at(-1)?.name;
-    let title =
-      prepareStringToBeValidFilename(operation?.summary) ??
-      `${method.toLowerCase()}-${prepareStringToBeValidFilename(path)}`;
+    let title = getOperationSlugBase({
+      slugSource: options.slug,
+      operationId: operation?.operationId,
+      summary: operation?.summary,
+      fallback: () => `${method.toLowerCase()}-${prepareStringToBeValidFilename(path)}`,
+    });
 
     let folder = prepareStringToBeValidFilename(tagName) ?? '';
     let base = posix.join(options.outDir ?? '', folder, title);
@@ -340,9 +346,13 @@ export function processOpenApiWebhook<N, DN>(
 
     const tagPath = resolveTags(operation?.tags);
     const tagName = tagPath.at(-1)?.name;
-    let title =
-      prepareStringToBeValidFilename(operation?.summary) ??
-      `${prepareStringToBeValidFilename(webhook)}`;
+    const summaryTitle = prepareStringToBeValidFilename(operation?.summary);
+    let title = getOperationSlugBase({
+      slugSource: options.slug,
+      operationId: operation?.operationId,
+      summary: operation?.summary,
+      fallback: () => `${prepareStringToBeValidFilename(webhook)}`,
+    });
     let folder = prepareStringToBeValidFilename(tagName) ?? '';
     let base = posix.join(options.outDir ?? '', folder, title);
 
@@ -376,7 +386,9 @@ export function processOpenApiWebhook<N, DN>(
         : xMint?.metadata;
 
     const page: DecoratedNavigationPage = {
-      title: slugToTitle(filenameWithoutExtension),
+      title: slugToTitle(
+        options.slug === 'operationId' && summaryTitle ? summaryTitle : filenameWithoutExtension
+      ),
       description: operation?.description,
       version: options.version,
       deprecated: operation?.deprecated,