docusaurus-theme-openapi-docs 0.0.0-1158 → 0.0.0-1160

package/lib/theme/ApiExplorer/ParamOptions/index.js

@@ -105,6 +105,10 @@ function getSchemaEnum(schema) {
       }
     }
   }
+  // const is semantically a single-value enum
+  if (schema?.const !== undefined) {
+    return [schema.const];
+  }
   return undefined;
 }
 function ParamOption({ param, label, type, required }) {

package/lib/theme/ParamsItem/index.js

@@ -88,11 +88,37 @@ function ParamsItem({ param, ...rest }) {
       })
     )
   );
+  const constValue = schema?.const;
   const renderQualifier = (0, utils_1.guard)(
     (0, schema_1.getQualifierMessage)(schema),
     (qualifier) =>
       react_1.default.createElement(Markdown_1.default, null, qualifier)
   );
+  function renderConstValue() {
+    if (constValue === undefined) {
+      return undefined;
+    }
+    const label = (0, Translate_1.translate)({
+      id: translationIds_1.OPENAPI_SCHEMA_ITEM.CONSTANT_VALUE,
+      message: "Constant value:",
+    });
+    return react_1.default.createElement(
+      "div",
+      null,
+      react_1.default.createElement("strong", null, label, " "),
+      react_1.default.createElement(
+        "span",
+        null,
+        react_1.default.createElement(
+          "code",
+          null,
+          typeof constValue === "string"
+            ? constValue
+            : JSON.stringify(constValue)
+        )
+      )
+    );
+  }
   const renderDescription = (0, utils_1.guard)(description, (description) =>
     react_1.default.createElement(Markdown_1.default, null, description)
   );
@@ -177,6 +203,7 @@ function ParamsItem({ param, ...rest }) {
       renderDeprecated
     ),
     renderQualifier,
+    renderConstValue(),
     renderDescription,
     renderEnumDescriptions,
     renderDefaultValue(),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-1158",
+  "version": "0.0.0-1160",
   "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-1158",
+    "docusaurus-plugin-openapi-docs": "0.0.0-1160",
     "docusaurus-plugin-sass": "^0.2.6",
     "eslint-plugin-prettier": "^5.5.1"
   },
@@ -82,5 +82,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "4b4edb328eed92cdea67b43309dc44af0b7c457d"
+  "gitHead": "9590f36ccddb212cb31943e14654c4a9a6884ec5"
 }

package/src/theme/ApiExplorer/ParamOptions/index.tsx

@@ -48,6 +48,11 @@ export function getSchemaEnum(schema: any): any[] | undefined {
     }
   }
 
+  // const is semantically a single-value enum
+  if (schema?.const !== undefined) {
+    return [schema.const];
+  }
+
   return undefined;
 }
 

package/src/theme/ParamsItem/index.tsx

@@ -102,10 +102,34 @@ function ParamsItem({ param, ...rest }: Props) {
     </span>
   ));
 
+  const constValue = schema?.const;
+
   const renderQualifier = guard(getQualifierMessage(schema), (qualifier) => (
     <Markdown>{qualifier}</Markdown>
   ));
 
+  function renderConstValue() {
+    if (constValue === undefined) {
+      return undefined;
+    }
+    const label = translate({
+      id: OPENAPI_SCHEMA_ITEM.CONSTANT_VALUE,
+      message: "Constant value:",
+    });
+    return (
+      <div>
+        <strong>{label} </strong>
+        <span>
+          <code>
+            {typeof constValue === "string"
+              ? constValue
+              : JSON.stringify(constValue)}
+          </code>
+        </span>
+      </div>
+    );
+  }
+
   const renderDescription = guard(description, (description) => (
     <Markdown>{description}</Markdown>
   ));
@@ -173,6 +197,7 @@ function ParamsItem({ param, ...rest }: Props) {
         {renderDeprecated}
       </span>
       {renderQualifier}
+      {renderConstValue()}
       {renderDescription}
       {renderEnumDescriptions}
       {renderDefaultValue()}