docusaurus-plugin-openapi-docs 0.0.0-803 → 0.0.0-824

package/lib/markdown/createDeprecationNotice.js

@@ -12,11 +12,10 @@ function createAdmonition({ children }) {
     return `:::caution deprecated\n\n${(0, utils_1.render)(children)}\n\n:::`;
 }
 function createDeprecationNotice({ deprecated, description, }) {
-    return (0, utils_1.guard)(deprecated, () => {
-        var _a;
-        return createAdmonition({
-            children: (_a = (0, utils_1.clean)(description)) !== null && _a !== void 0 ? _a : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
-        });
-    });
+    return (0, utils_1.guard)(deprecated, () => createAdmonition({
+        children: description && description.length > 0
+            ? (0, utils_1.clean)(description)
+            : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
+    }));
 }
 exports.createDeprecationNotice = createDeprecationNotice;

package/lib/markdown/createParamsDetails.js

@@ -35,10 +35,16 @@ function createParamsDetails({ parameters, type }) {
             (0, utils_1.create)("div", {
                 children: [
                     (0, utils_1.create)("ul", {
-                        children: params.map((param) => (0, utils_1.create)("ParamsItem", {
-                            className: "paramsItem",
-                            param: param,
-                        })),
+                        children: params.map((param) => {
+                            var _a, _b, _c;
+                            return (0, utils_1.create)("ParamsItem", {
+                                className: "paramsItem",
+                                param: {
+                                    ...param,
+                                    enumDescriptions: Object.entries((_c = (_b = (_a = param === null || param === void 0 ? void 0 : param.schema) === null || _a === void 0 ? void 0 : _a.items) === null || _b === void 0 ? void 0 : _b["x-enumDescriptions"]) !== null && _c !== void 0 ? _c : {}),
+                                },
+                            });
+                        }),
                     }),
                 ],
             }),

package/lib/markdown/createSchema.js

@@ -351,14 +351,14 @@ function createDetailsNode(name, schemaName, schema, required, nullable) {
                     (0, utils_1.create)("div", {
                         style: { marginLeft: "1rem" },
                         children: [
-                            (0, utils_1.guard)((0, schema_1.getQualifierMessage)(schema), (message) => (0, utils_1.create)("div", {
-                                style: { marginTop: ".5rem", marginBottom: ".5rem" },
-                                children: (0, createDescription_1.createDescription)(message),
-                            })),
                             (0, utils_1.guard)(schema.description, (description) => (0, utils_1.create)("div", {
                                 style: { marginTop: ".5rem", marginBottom: ".5rem" },
                                 children: (0, createDescription_1.createDescription)(description),
                             })),
+                            (0, utils_1.guard)((0, schema_1.getQualifierMessage)(schema), (message) => (0, utils_1.create)("div", {
+                                style: { marginTop: ".5rem", marginBottom: ".5rem" },
+                                children: (0, createDescription_1.createDescription)(message),
+                            })),
                             createNodes(schema, SCHEMA_TYPE),
                         ],
                     }),
@@ -478,17 +478,17 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
                         ]),
                     ],
                 }),
-                (0, utils_1.guard)((0, schema_1.getQualifierMessage)(discriminator), (message) => (0, utils_1.create)("div", {
+                (0, utils_1.guard)(schema.description, (description) => (0, utils_1.create)("div", {
                     style: {
                         paddingLeft: "1rem",
                     },
-                    children: (0, createDescription_1.createDescription)(message),
+                    children: (0, createDescription_1.createDescription)(description),
                 })),
-                (0, utils_1.guard)(schema.description, (description) => (0, utils_1.create)("div", {
+                (0, utils_1.guard)((0, schema_1.getQualifierMessage)(discriminator), (message) => (0, utils_1.create)("div", {
                     style: {
                         paddingLeft: "1rem",
                     },
-                    children: (0, createDescription_1.createDescription)(description),
+                    children: (0, createDescription_1.createDescription)(message),
                 })),
                 (0, utils_1.create)("DiscriminatorTabs", {
                     className: "openapi-tabs__discriminator",

package/lib/openapi/types.d.ts

@@ -163,6 +163,7 @@ export interface ParameterObject {
     examples?: Map<ExampleObject>;
     content?: Map<MediaTypeObject>;
     param?: Object;
+    "x-enumDescriptions"?: Record<string, string>;
 }
 export interface ParameterObjectWithRef {
     name: string;
@@ -279,6 +280,7 @@ export type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf"
     example?: any;
     deprecated?: boolean;
     "x-tags"?: string[];
+    "x-enumDescriptions"?: Record<string, string>;
 };
 export type SchemaObjectWithRef = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
     type?: "string" | "number" | "integer" | "boolean" | "object" | "array";

package/lib/openapi/utils/services/OpenAPIParser.js

@@ -215,7 +215,7 @@ class OpenAPIParser {
         })
             .filter((child) => child !== undefined);
         for (const { $ref: subSchemaRef, schema: subSchema } of allOfSchemas) {
-            const { type, enum: enumProperty, properties, items, required, oneOf, anyOf, title, ...otherConstraints } = subSchema;
+            const { type, enum: enumProperty, "x-enumDescription": enumDescription, properties, items, required, oneOf, anyOf, title, ...otherConstraints } = subSchema;
             if (receiver.type !== type &&
                 receiver.type !== undefined &&
                 type !== undefined) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-803",
+  "version": "0.0.0-824",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "e2ff586260fa651fbd0a39efc9413699f88942e7"
+  "gitHead": "34abb2de0893a52b7e236e054e8d391f01ff0bc1"
 }

package/src/markdown/createDeprecationNotice.ts

@@ -23,8 +23,9 @@ export function createDeprecationNotice({
   return guard(deprecated, () =>
     createAdmonition({
       children:
-        clean(description) ??
-        "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
+        description && description.length > 0
+          ? clean(description)
+          : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
     })
   );
 }

package/src/markdown/createParamsDetails.ts

@@ -43,12 +43,17 @@ export function createParamsDetails({ parameters, type }: Props) {
       create("div", {
         children: [
           create("ul", {
-            children: params.map((param) =>
-              create("ParamsItem", {
+            children: params.map((param) => {
+              return create("ParamsItem", {
                 className: "paramsItem",
-                param: param,
-              })
-            ),
+                param: {
+                  ...param,
+                  enumDescriptions: Object.entries(
+                    param?.schema?.items?.["x-enumDescriptions"] ?? {}
+                  ),
+                },
+              });
+            }),
           }),
         ],
       }),

package/src/markdown/createSchema.ts

@@ -416,16 +416,16 @@ function createDetailsNode(
           create("div", {
             style: { marginLeft: "1rem" },
             children: [
-              guard(getQualifierMessage(schema), (message) =>
+              guard(schema.description, (description) =>
                 create("div", {
                   style: { marginTop: ".5rem", marginBottom: ".5rem" },
-                  children: createDescription(message),
+                  children: createDescription(description),
                 })
               ),
-              guard(schema.description, (description) =>
+              guard(getQualifierMessage(schema), (message) =>
                 create("div", {
                   style: { marginTop: ".5rem", marginBottom: ".5rem" },
-                  children: createDescription(description),
+                  children: createDescription(message),
                 })
               ),
               createNodes(schema, SCHEMA_TYPE),
@@ -559,20 +559,20 @@ function createPropertyDiscriminator(
             ]),
           ],
         }),
-        guard(getQualifierMessage(discriminator), (message) =>
+        guard(schema.description, (description) =>
           create("div", {
             style: {
               paddingLeft: "1rem",
             },
-            children: createDescription(message),
+            children: createDescription(description),
           })
         ),
-        guard(schema.description, (description) =>
+        guard(getQualifierMessage(discriminator), (message) =>
           create("div", {
             style: {
               paddingLeft: "1rem",
             },
-            children: createDescription(description),
+            children: createDescription(message),
           })
         ),
         create("DiscriminatorTabs", {

package/src/openapi/types.ts

@@ -197,6 +197,7 @@ export interface ParameterObject {
   param?: Object;
   // ignoring stylings: matrix, label, form, simple, spaceDelimited,
   // pipeDelimited and deepObject
+  "x-enumDescriptions"?: Record<string, string>;
 }
 
 export interface ParameterObjectWithRef {
@@ -353,6 +354,7 @@ export type SchemaObject = Omit<
   example?: any;
   deprecated?: boolean;
   "x-tags"?: string[];
+  "x-enumDescriptions"?: Record<string, string>;
 };
 
 export type SchemaObjectWithRef = Omit<

package/src/openapi/utils/services/OpenAPIParser.ts

@@ -270,6 +270,7 @@ export class OpenAPIParser {
       const {
         type,
         enum: enumProperty,
+        "x-enumDescription": enumDescription,
         properties,
         items,
         required,