@mintlify/common 1.0.1362 → 1.0.1363

package/dist/openapi/getTagDisplayName.d.ts

@@ -1,5 +1,16 @@
-import { OpenAPI } from 'openapi-types';
+import { OpenAPI, OpenAPIV3 } from 'openapi-types';
+type TagWithExtensions = OpenAPIV3.TagObject & {
+    'x-group'?: string;
+    'x-displayName'?: string;
+};
 /**
- * Resolves the display name for a tag. Prioritizes x-group extension, falls back to tag name.
+ * Resolves a tag label from its extensions: the x-group extension first, then the Redocly
+ * x-displayName extension. Returns undefined when neither is set.
+ */
+export declare const getTagLabelFromExtensions: (tag: Pick<TagWithExtensions, 'x-group' | 'x-displayName'> | undefined) => string | undefined;
+/**
+ * Resolves the display name for a tag. Prioritizes the x-group extension, then the Redocly
+ * x-displayName extension, and falls back to the tag name.
  */
 export declare const getTagDisplayName: (tagName: string | undefined, schema: Pick<OpenAPI.Document, 'tags'>) => string | undefined;
+export {};

package/dist/openapi/getTagDisplayName.js

@@ -1,5 +1,11 @@
 /**
- * Resolves the display name for a tag. Prioritizes x-group extension, falls back to tag name.
+ * Resolves a tag label from its extensions: the x-group extension first, then the Redocly
+ * x-displayName extension. Returns undefined when neither is set.
+ */
+export const getTagLabelFromExtensions = (tag) => { var _a; return (_a = tag === null || tag === void 0 ? void 0 : tag['x-group']) !== null && _a !== void 0 ? _a : tag === null || tag === void 0 ? void 0 : tag['x-displayName']; };
+/**
+ * Resolves the display name for a tag. Prioritizes the x-group extension, then the Redocly
+ * x-displayName extension, and falls back to the tag name.
  */
 export const getTagDisplayName = (tagName, schema) => {
     var _a;
@@ -9,5 +15,5 @@ export const getTagDisplayName = (tagName, schema) => {
     if (!tags)
         return tagName;
     const tagDef = tags.find((t) => t.name === tagName);
-    return (_a = tagDef === null || tagDef === void 0 ? void 0 : tagDef['x-group']) !== null && _a !== void 0 ? _a : tagName;
+    return (_a = getTagLabelFromExtensions(tagDef)) !== null && _a !== void 0 ? _a : tagName;
 };

package/dist/openapi/tagHierarchy.d.ts

@@ -2,6 +2,7 @@ import type { DocumentV3, OpenAPIV3_2 } from '@mintlify/validation';
 import type { OpenAPI } from 'openapi-types';
 export type OpenApiTag = OpenAPIV3_2.TagObject & {
     'x-group'?: string;
+    'x-displayName'?: string;
 };
 export type OpenApiTagGroup = {
     name: string;

package/dist/openapi/tagHierarchy.js

@@ -1,4 +1,4 @@
-import { getTagDisplayName } from './getTagDisplayName.js';
+import { getTagDisplayName, getTagLabelFromExtensions } from './getTagDisplayName.js';
 import { isOpenApi32Version } from './validate.js';
 export const isOpenApi32 = (schema) => 'openapi' in schema && isOpenApi32Version(schema.openapi);
 export function validateOpenApiTagTree(tags = []) {
@@ -53,7 +53,7 @@ export function createOpenApiTagResolver(schema) {
             if ((tag === null || tag === void 0 ? void 0 : tag.kind) === undefined || tag.kind === 'nav' || current === name) {
                 path.push({
                     name: current,
-                    label: (_a = tag === null || tag === void 0 ? void 0 : tag['x-group']) !== null && _a !== void 0 ? _a : ((tag === null || tag === void 0 ? void 0 : tag.summary) || current),
+                    label: (_a = getTagLabelFromExtensions(tag)) !== null && _a !== void 0 ? _a : ((tag === null || tag === void 0 ? void 0 : tag.summary) || current),
                     key: current,
                 });
             }