@mintlify/scraping 4.0.227 → 4.0.229

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/scraping",
-  "version": "4.0.227",
+  "version": "4.0.229",
   "description": "Scrape documentation frameworks to Mintlify docs",
   "engines": {
     "node": ">=18.0.0"
@@ -38,7 +38,7 @@
     "format:check": "prettier . --check"
   },
   "dependencies": {
-    "@mintlify/common": "1.0.371",
+    "@mintlify/common": "1.0.373",
     "@mintlify/openapi-parser": "^0.0.7",
     "fs-extra": "^11.1.1",
     "hast-util-to-mdast": "^10.1.0",
@@ -61,7 +61,7 @@
     "@mintlify/models": "0.0.189",
     "@mintlify/prettier-config": "1.0.4",
     "@mintlify/ts-config": "2.0.2",
-    "@mintlify/validation": "0.1.359",
+    "@mintlify/validation": "0.1.360",
     "@trivago/prettier-plugin-sort-imports": "^4.2.1",
     "@tsconfig/recommended": "1.x",
     "@types/hast": "^3.0.4",
@@ -77,5 +77,5 @@
     "typescript": "^5.5.3",
     "vitest": "^2.0.4"
   },
-  "gitHead": "921d76e2b023827b7721a73e11c8d954a4cc61fe"
+  "gitHead": "212bec92baf66057a5539dd6c40509f003770159"
 }

package/src/openapi/common.ts

@@ -3,6 +3,7 @@ import {
   OperationObject,
   optionallyAddLeadingSlash,
   slugToTitle,
+  buildOpenApiMetaTag,
 } from '@mintlify/common';
 import type { DecoratedNavigationPage } from '@mintlify/models';
 import { outputFile } from 'fs-extra';
@@ -47,13 +48,21 @@ export const getOpenApiDefinition = async (
   return { document: pathOrDocumentOrUrl, isUrl };
 };
 
-export const createOpenApiFrontmatter = async (
-  filename: string,
-  openApiMetaTag: string,
-  version?: string
-) => {
+export const createOpenApiFrontmatter = async ({
+  filename,
+  openApiMetaTag,
+  version,
+  deprecated,
+}: {
+  filename: string;
+  openApiMetaTag: string;
+  version?: string;
+  deprecated?: boolean;
+}) => {
   const data = `---
-openapi: ${openApiMetaTag}${version ? `\nversion: ${version}` : ''}
+openapi: ${openApiMetaTag}${version ? `\nversion: ${version}` : ''}${
+    deprecated ? `\ndeprecated: ${deprecated}` : ''
+  }
 ---`;
 
   await outputFile(filename, data);
@@ -89,22 +98,6 @@ const isExcludedOperation = (operation: MaybeOperationObjectWithExtensions) => {
   return operation['x-excluded'];
 };
 
-const buildOpenApiMetaTag = ({
-  openApiFilePathFromRoot,
-  method,
-  path,
-  deprecated,
-}: {
-  openApiFilePathFromRoot: string | undefined;
-  method: string;
-  path: string;
-  deprecated: boolean;
-}): string => {
-  const filePath = openApiFilePathFromRoot ? `${openApiFilePathFromRoot} ` : '';
-  const label = deprecated ? ` deprecated` : '';
-  return `${filePath}${method} ${path}${label}`;
-};
-
 export function processOpenApiPath<N, DN>(
   path: string,
   pathItemObject: OpenAPIV3.PathItemObject,
@@ -139,10 +132,9 @@ export function processOpenApiPath<N, DN>(
 
       const filenameWithoutExtension = generateUniqueFilenameWithoutExtension(navGroup, base);
       const openapiMetaTag = buildOpenApiMetaTag({
-        openApiFilePathFromRoot,
+        filePath: openApiFilePathFromRoot,
         method,
         path,
-        deprecated: operation?.deprecated ?? false,
       });
       const { title: titleTag, description } = getOpenApiTitleAndDescription(
         [
@@ -161,6 +153,7 @@ export function processOpenApiPath<N, DN>(
         href: resolve('/', filenameWithoutExtension),
         title: titleTag ?? slugToTitle(filenameWithoutExtension),
         description,
+        deprecated: operation?.deprecated,
         version: options.version,
       };
 
@@ -173,7 +166,14 @@ export function processOpenApiPath<N, DN>(
         ? join(options.outDirBasePath, `${filenameWithoutExtension}.mdx`)
         : `${filenameWithoutExtension}.mdx`;
       if (options.writeFiles && (!fse.pathExistsSync(targetPath) || options.overwrite)) {
-        writePromises.push(createOpenApiFrontmatter(targetPath, openapiMetaTag, options.version));
+        writePromises.push(
+          createOpenApiFrontmatter({
+            filename: targetPath,
+            openApiMetaTag: openapiMetaTag,
+            version: options.version,
+            deprecated: operation?.deprecated,
+          })
+        );
       }
     }
   });
@@ -214,10 +214,9 @@ export function processOpenApiWebhook<N, DN>(
       const filenameWithoutExtension = generateUniqueFilenameWithoutExtension(navGroup, base);
 
       const openapiMetaTag = buildOpenApiMetaTag({
-        openApiFilePathFromRoot,
+        filePath: openApiFilePathFromRoot,
         method: 'webhook',
         path: webhook,
-        deprecated: operation?.deprecated ?? false,
       });
 
       const description = operation?.description;
@@ -228,6 +227,7 @@ export function processOpenApiWebhook<N, DN>(
         title: slugToTitle(filenameWithoutExtension),
         description,
         version: options.version,
+        deprecated: operation?.deprecated,
       };
 
       if (!isHiddenOperation(operation as MaybeOperationObjectWithExtensions)) {
@@ -239,7 +239,14 @@ export function processOpenApiWebhook<N, DN>(
         ? join(options.outDirBasePath, `${filenameWithoutExtension}.mdx`)
         : `${filenameWithoutExtension}.mdx`;
       if (options.writeFiles && (!fse.pathExistsSync(targetPath) || options.overwrite)) {
-        writePromises.push(createOpenApiFrontmatter(targetPath, openapiMetaTag, options.version));
+        writePromises.push(
+          createOpenApiFrontmatter({
+            filename: targetPath,
+            openApiMetaTag: openapiMetaTag,
+            version: options.version,
+            deprecated: operation?.deprecated,
+          })
+        );
       }
     }
   });