docusaurus-theme-openapi-docs 0.0.0-1155 → 0.0.0-1156

package/lib/markdown/schema.js

@@ -121,14 +121,22 @@ function getQualifierMessage(schema) {
         let lengthQualifier = "";
         let minLength;
         let maxLength;
+        const charactersMessage = (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_SCHEMA_ITEM.CHARACTERS,
+            message: "characters",
+        });
+        const nonEmptyMessage = (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_SCHEMA_ITEM.NON_EMPTY,
+            message: "non-empty",
+        });
         if (schema.minLength && schema.minLength > 1) {
-            minLength = `\`>= ${schema.minLength} characters\``;
+            minLength = `\`>= ${schema.minLength} ${charactersMessage}\``;
         }
         if (schema.minLength && schema.minLength === 1) {
-            minLength = `\`non-empty\``;
+            minLength = `\`${nonEmptyMessage}\``;
         }
         if (schema.maxLength) {
-            maxLength = `\`<= ${schema.maxLength} characters\``;
+            maxLength = `\`<= ${schema.maxLength} ${charactersMessage}\``;
         }
         if (minLength && !maxLength) {
             lengthQualifier += minLength;
@@ -178,7 +186,11 @@ function getQualifierMessage(schema) {
         qualifierGroups.push(minmaxQualifier);
     }
     if (schema.pattern) {
-        qualifierGroups.push(`Value must match regular expression \`${schema.pattern}\``);
+        const expressionMessage = (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_SCHEMA_ITEM.EXPRESSION,
+            message: "Value must match regular expression",
+        });
+        qualifierGroups.push(`${expressionMessage} \`${schema.pattern}\``);
     }
     // Check if discriminator mapping
     const discriminator = schema;

package/lib/theme/ResponseHeaders/index.js

@@ -27,7 +27,6 @@ const ResponseHeaders = ({ responseHeaders }) => {
         name: name,
         collapsible: false,
         schemaName: (0, schema_1.getSchemaName)(schema),
-        qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
         schema: schema,
         discriminator: false,
         children: null,

package/lib/theme/Schema/index.d.ts

@@ -1,5 +1,5 @@
 import React from "react";
-import type { SchemaObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
+import type { SchemaObject } from "../../types.d";
 interface SchemaProps {
     schema: SchemaObject;
     schemaType: "request" | "response";

package/lib/theme/Schema/index.js

@@ -84,8 +84,8 @@ const translationIds_1 = require("@theme/translationIds");
 // eslint-disable-next-line import/no-extraneous-dependencies
 const allof_merge_1 = require("allof-merge");
 const clsx_1 = __importDefault(require("clsx"));
-const schema_1 = require("docusaurus-plugin-openapi-docs/lib/markdown/schema");
 const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
+const schema_1 = require("../../markdown/schema");
 // eslint-disable-next-line import/no-extraneous-dependencies
 // const jsonSchemaMergeAllOf = require("json-schema-merge-allof");
 const mergeAllOf = (allOf) => {
@@ -311,9 +311,6 @@ const AnyOneOf = ({ schema, schemaType, schemaPath }) => {
                 collapsible: false,
                 name: undefined,
                 schemaName: computedSchemaName,
-                qualifierMessage: (0, schema_1.getQualifierMessage)(
-                  anyOneSchema
-                ),
                 schema: anyOneSchema,
                 discriminator: false,
                 children: null,
@@ -327,9 +324,6 @@ const AnyOneOf = ({ schema, schemaType, schemaPath }) => {
                 collapsible: false,
                 name: undefined,
                 schemaName: computedSchemaName,
-                qualifierMessage: (0, schema_1.getQualifierMessage)(
-                  anyOneSchema
-                ),
                 schema: anyOneSchema,
                 discriminator: false,
                 children: null,
@@ -398,7 +392,6 @@ const Properties = ({ schema, schemaType, schemaPath }) => {
       name: "",
       required: false,
       schemaName: "object",
-      qualifierMessage: undefined,
       schema: {},
     });
   }
@@ -594,7 +587,6 @@ const AdditionalProperties = ({ schema, schemaType }) => {
       name: "property name*",
       required: false,
       schemaName: "any",
-      qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
       schema: schema,
       collapsible: false,
       discriminator: false,
@@ -635,7 +627,6 @@ const AdditionalProperties = ({ schema, schemaType }) => {
       name: "property name*",
       required: false,
       schemaName: schemaName,
-      qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
       schema: additionalProperties,
       collapsible: false,
       discriminator: false,
@@ -740,7 +731,6 @@ const Items = ({ schema, schemaType, schemaPath }) => {
         collapsible: false,
         name: "", // No name for array items
         schemaName: (0, schema_1.getSchemaName)(itemsSchema),
-        qualifierMessage: (0, schema_1.getQualifierMessage)(itemsSchema),
         schema: itemsSchema,
         discriminator: false,
         children: null,
@@ -861,7 +851,6 @@ const SchemaEdge = ({
         name: name,
         required: Array.isArray(required) ? required.includes(name) : required,
         schemaName: schema.allOf[0],
-        qualifierMessage: undefined,
         schema: schema.allOf[0],
         discriminator: false,
         children: null,
@@ -913,7 +902,6 @@ const SchemaEdge = ({
       name: name,
       required: Array.isArray(required) ? required.includes(name) : required,
       schemaName: mergedSchemaName,
-      qualifierMessage: (0, schema_1.getQualifierMessage)(mergedSchemas),
       schema: mergedSchemas,
       discriminator: false,
       children: null,
@@ -924,7 +912,6 @@ const SchemaEdge = ({
     name: name,
     required: Array.isArray(required) ? required.includes(name) : required,
     schemaName: schemaName,
-    qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
     schema: schema,
     discriminator: false,
     children: null,
@@ -1092,7 +1079,6 @@ const SchemaNode = ({ schema, schemaType, schemaPath }) => {
       name: schema.type,
       required: Boolean(schema.required),
       schemaName: schemaName,
-      qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
       schema: schema,
       discriminator: false,
       children: null,

package/lib/theme/SchemaItem/index.js

@@ -18,6 +18,7 @@ const Example_1 = require("@theme/Example");
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const translationIds_1 = require("@theme/translationIds");
 const clsx_1 = __importDefault(require("clsx"));
+const schema_1 = require("../../markdown/schema");
 const utils_1 = require("../../markdown/utils");
 const transformEnumDescriptions = (enumDescriptions) => {
   if (enumDescriptions) {
@@ -127,8 +128,12 @@ function SchemaItem(props) {
         react_1.default.createElement(Markdown_1.default, null, description)
       )
   );
+  // Generate qualifierMessage from schema if not provided
+  const effectiveQualifierMessage =
+    qualifierMessage ??
+    (schema ? (0, schema_1.getQualifierMessage)(schema) : undefined);
   const renderQualifierMessage = (0, utils_1.guard)(
-    qualifierMessage,
+    effectiveQualifierMessage,
     (message) =>
       react_1.default.createElement(
         react_1.default.Fragment,

package/lib/theme/translationIds.d.ts

@@ -60,6 +60,8 @@ export declare const OPENAPI_SCHEMA: {
     NO_SCHEMA: string;
 };
 export declare const OPENAPI_SCHEMA_ITEM: {
+    CHARACTERS: string;
+    NON_EMPTY: string;
     REQUIRED: string;
     DEPRECATED: string;
     NULLABLE: string;
@@ -71,6 +73,7 @@ export declare const OPENAPI_SCHEMA_ITEM: {
     ENUM_VALUE: string;
     ENUM_DESCRIPTION: string;
     POSSIBLE_VALUES: string;
+    EXPRESSION: string;
     ONE_OF: string;
     ANY_OF: string;
 };

package/lib/theme/translationIds.js

@@ -84,6 +84,8 @@ exports.OPENAPI_SCHEMA = {
   NO_SCHEMA: "theme.openapi.schema.noSchema",
 };
 exports.OPENAPI_SCHEMA_ITEM = {
+  CHARACTERS: "theme.openapi.schemaItem.characters",
+  NON_EMPTY: "theme.openapi.schemaItem.nonEmpty",
   REQUIRED: "theme.openapi.schemaItem.required",
   DEPRECATED: "theme.openapi.schemaItem.deprecated",
   NULLABLE: "theme.openapi.schemaItem.nullable",
@@ -95,6 +97,7 @@ exports.OPENAPI_SCHEMA_ITEM = {
   ENUM_VALUE: "theme.openapi.schemaItem.enumValue",
   ENUM_DESCRIPTION: "theme.openapi.schemaItem.enumDescription",
   POSSIBLE_VALUES: "theme.openapi.schemaItem.possibleValues",
+  EXPRESSION: "theme.openapi.schemaItem.expression",
   ONE_OF: "theme.openapi.schemaItem.oneOf",
   ANY_OF: "theme.openapi.schemaItem.anyOf",
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-1155",
+  "version": "0.0.0-1156",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -38,7 +38,7 @@
     "@types/postman-collection": "^3.5.11",
     "@types/react-modal": "^3.16.3",
     "concurrently": "^9.2.0",
-    "docusaurus-plugin-openapi-docs": "0.0.0-1155",
+    "docusaurus-plugin-openapi-docs": "0.0.0-1156",
     "docusaurus-plugin-sass": "^0.2.6",
     "eslint-plugin-prettier": "^5.5.1"
   },
@@ -82,5 +82,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "388036c8328b54f841365688b671422a418098bb"
+  "gitHead": "15f538e349ea6e12482cb5a53dea9c349fd9157e"
 }

package/src/markdown/schema.ts

@@ -140,9 +140,7 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
   if (schema.items) {
     const itemsEnum = getEnumFromSchema(schema.items as SchemaObject);
     if (itemsEnum) {
-      qualifierGroups.push(
-        `[${itemsEnum.map((e) => `\`${e}\``).join(", ")}]`
-      );
+      qualifierGroups.push(`[${itemsEnum.map((e) => `\`${e}\``).join(", ")}]`);
     }
   }
 
@@ -150,14 +148,22 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
     let lengthQualifier = "";
     let minLength;
     let maxLength;
+    const charactersMessage = translate({
+      id: OPENAPI_SCHEMA_ITEM.CHARACTERS,
+      message: "characters",
+    });
+    const nonEmptyMessage = translate({
+      id: OPENAPI_SCHEMA_ITEM.NON_EMPTY,
+      message: "non-empty",
+    });
     if (schema.minLength && schema.minLength > 1) {
-      minLength = `\`>= ${schema.minLength} characters\``;
+      minLength = `\`>= ${schema.minLength} ${charactersMessage}\``;
     }
     if (schema.minLength && schema.minLength === 1) {
-      minLength = `\`non-empty\``;
+      minLength = `\`${nonEmptyMessage}\``;
     }
     if (schema.maxLength) {
-      maxLength = `\`<= ${schema.maxLength} characters\``;
+      maxLength = `\`<= ${schema.maxLength} ${charactersMessage}\``;
     }
 
     if (minLength && !maxLength) {
@@ -211,9 +217,11 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
   }
 
   if (schema.pattern) {
-    qualifierGroups.push(
-      `Value must match regular expression \`${schema.pattern}\``
-    );
+    const expressionMessage = translate({
+      id: OPENAPI_SCHEMA_ITEM.EXPRESSION,
+      message: "Value must match regular expression",
+    });
+    qualifierGroups.push(`${expressionMessage} \`${schema.pattern}\``);
   }
 
   // Check if discriminator mapping

package/src/theme/ResponseHeaders/index.tsx

@@ -9,7 +9,7 @@ import React from "react";
 
 import SchemaItem from "@theme/SchemaItem";
 
-import { getQualifierMessage, getSchemaName } from "../../markdown/schema";
+import { getSchemaName } from "../../markdown/schema";
 
 interface ResponseHeadersProps {
   description?: string;
@@ -35,7 +35,6 @@ export const ResponseHeaders: React.FC<{
             name={name}
             collapsible={false}
             schemaName={getSchemaName(schema)}
-            qualifierMessage={getQualifierMessage(schema)}
             schema={schema}
             discriminator={false}
             children={null}

package/src/theme/Schema/index.tsx

@@ -21,16 +21,11 @@ import { OPENAPI_SCHEMA_ITEM } from "@theme/translationIds";
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { merge } from "allof-merge";
 import clsx from "clsx";
-import {
-  getQualifierMessage,
-  getSchemaName,
-} from "docusaurus-plugin-openapi-docs/lib/markdown/schema";
-import type {
-  SchemaObject,
-  SchemaType,
-} from "docusaurus-plugin-openapi-docs/src/openapi/types";
 import isEmpty from "lodash/isEmpty";
 
+import { getQualifierMessage, getSchemaName } from "../../markdown/schema";
+import type { SchemaObject } from "../../types.d";
+
 // eslint-disable-next-line import/no-extraneous-dependencies
 // const jsonSchemaMergeAllOf = require("json-schema-merge-allof");
 
@@ -304,7 +299,6 @@ const AnyOneOf: React.FC<SchemaProps> = ({
                   collapsible={false}
                   name={undefined}
                   schemaName={computedSchemaName}
-                  qualifierMessage={getQualifierMessage(anyOneSchema)}
                   schema={anyOneSchema}
                   discriminator={false}
                   children={null}
@@ -321,7 +315,6 @@ const AnyOneOf: React.FC<SchemaProps> = ({
                     collapsible={false}
                     name={undefined}
                     schemaName={computedSchemaName}
-                    qualifierMessage={getQualifierMessage(anyOneSchema)}
                     schema={anyOneSchema}
                     discriminator={false}
                     children={null}
@@ -406,7 +399,6 @@ const Properties: React.FC<SchemaProps> = ({
         name=""
         required={false}
         schemaName="object"
-        qualifierMessage={undefined}
         schema={{}}
       />
     );
@@ -619,7 +611,6 @@ const AdditionalProperties: React.FC<SchemaProps> = ({
         name="property name*"
         required={false}
         schemaName="any"
-        qualifierMessage={getQualifierMessage(schema)}
         schema={schema}
         collapsible={false}
         discriminator={false}
@@ -665,7 +656,6 @@ const AdditionalProperties: React.FC<SchemaProps> = ({
         name="property name*"
         required={false}
         schemaName={schemaName}
-        qualifierMessage={getQualifierMessage(schema)}
         schema={additionalProperties}
         collapsible={false}
         discriminator={false}
@@ -775,7 +765,6 @@ const Items: React.FC<{
           collapsible={false}
           name="" // No name for array items
           schemaName={getSchemaName(itemsSchema)}
-          qualifierMessage={getQualifierMessage(itemsSchema)}
           schema={itemsSchema}
           discriminator={false}
           children={null}
@@ -935,7 +924,6 @@ const SchemaEdge: React.FC<SchemaEdgeProps> = ({
             Array.isArray(required) ? required.includes(name) : required
           }
           schemaName={schema.allOf[0]}
-          qualifierMessage={undefined}
           schema={schema.allOf[0]}
           discriminator={false}
           children={null}
@@ -1007,7 +995,6 @@ const SchemaEdge: React.FC<SchemaEdgeProps> = ({
         name={name}
         required={Array.isArray(required) ? required.includes(name) : required}
         schemaName={mergedSchemaName}
-        qualifierMessage={getQualifierMessage(mergedSchemas)}
         schema={mergedSchemas}
         discriminator={false}
         children={null}
@@ -1021,7 +1008,6 @@ const SchemaEdge: React.FC<SchemaEdgeProps> = ({
       name={name}
       required={Array.isArray(required) ? required.includes(name) : required}
       schemaName={schemaName}
-      qualifierMessage={getQualifierMessage(schema)}
       schema={schema}
       discriminator={false}
       children={null}
@@ -1225,7 +1211,6 @@ const SchemaNode: React.FC<SchemaProps> = ({
         name={schema.type}
         required={Boolean(schema.required)}
         schemaName={schemaName}
-        qualifierMessage={getQualifierMessage(schema)}
         schema={schema}
         discriminator={false}
         children={null}
@@ -1238,7 +1223,9 @@ const SchemaNode: React.FC<SchemaProps> = ({
 
 export default SchemaNode;
 
-type PrimitiveSchemaType = Exclude<SchemaType, "object" | "array">;
+type PrimitiveSchemaType =
+  | Exclude<NonNullable<SchemaObject["type"]>, "object" | "array">
+  | "null";
 
 const PRIMITIVE_TYPES: Record<PrimitiveSchemaType, true> = {
   string: true,

package/src/theme/SchemaItem/index.tsx

@@ -13,6 +13,7 @@ import Markdown from "@theme/Markdown";
 import { OPENAPI_SCHEMA_ITEM } from "@theme/translationIds";
 import clsx from "clsx";
 
+import { getQualifierMessage } from "../../markdown/schema";
 import { guard } from "../../markdown/utils";
 
 export interface Props {
@@ -130,7 +131,11 @@ export default function SchemaItem(props: Props) {
     </>
   ));
 
-  const renderQualifierMessage = guard(qualifierMessage, (message) => (
+  // Generate qualifierMessage from schema if not provided
+  const effectiveQualifierMessage =
+    qualifierMessage ?? (schema ? getQualifierMessage(schema) : undefined);
+
+  const renderQualifierMessage = guard(effectiveQualifierMessage, (message) => (
     <>
       <Markdown>{message}</Markdown>
     </>

package/src/theme/translationIds.ts

@@ -79,6 +79,8 @@ export const OPENAPI_SCHEMA = {
 };
 
 export const OPENAPI_SCHEMA_ITEM = {
+  CHARACTERS: "theme.openapi.schemaItem.characters",
+  NON_EMPTY: "theme.openapi.schemaItem.nonEmpty",
   REQUIRED: "theme.openapi.schemaItem.required",
   DEPRECATED: "theme.openapi.schemaItem.deprecated",
   NULLABLE: "theme.openapi.schemaItem.nullable",
@@ -90,6 +92,7 @@ export const OPENAPI_SCHEMA_ITEM = {
   ENUM_VALUE: "theme.openapi.schemaItem.enumValue",
   ENUM_DESCRIPTION: "theme.openapi.schemaItem.enumDescription",
   POSSIBLE_VALUES: "theme.openapi.schemaItem.possibleValues",
+  EXPRESSION: "theme.openapi.schemaItem.expression",
   ONE_OF: "theme.openapi.schemaItem.oneOf",
   ANY_OF: "theme.openapi.schemaItem.anyOf",
 };