docusaurus-plugin-openapi-docs 0.0.0-1069 → 0.0.0-1073

package/lib/openapi/createSchemaExample.js

@@ -77,7 +77,7 @@ const sampleFromSchema = (schema = {}, context) => {
     try {
         // deep copy schema before processing
         let schemaCopy = JSON.parse(JSON.stringify(schema));
-        let { type, example, allOf, properties, items, oneOf, anyOf } = schemaCopy;
+        let { type, example, allOf, properties, items, oneOf, anyOf, const: constant, } = schemaCopy;
         if (example !== undefined) {
             return example;
         }
@@ -169,6 +169,9 @@ const sampleFromSchema = (schema = {}, context) => {
         if (shouldExcludeProperty(schemaCopy, context)) {
             return undefined;
         }
+        if (constant) {
+            return constant;
+        }
         return primitive(schemaCopy);
     }
     catch (err) {

package/lib/openapi/createSchemaExample.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/openapi/createSchemaExample.test.js

@@ -0,0 +1,48 @@
+"use strict";
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+const createSchemaExample_1 = require("./createSchemaExample");
+describe("sampleFromSchema", () => {
+    describe("const support", () => {
+        it("should return default string value when const is not present", () => {
+            const schema = {
+                type: "string",
+            };
+            const context = { type: "request" };
+            const result = (0, createSchemaExample_1.sampleFromSchema)(schema, context);
+            expect(result).toBe("string");
+        });
+        it("should return const value when const is present", () => {
+            const schema = {
+                type: "string",
+                const: "example",
+            };
+            const context = { type: "request" };
+            const result = (0, createSchemaExample_1.sampleFromSchema)(schema, context);
+            expect(result).toBe("example");
+        });
+        it("should handle anyOf with const values", () => {
+            const schema = {
+                type: "string",
+                anyOf: [
+                    {
+                        type: "string",
+                        const: "dog",
+                    },
+                    {
+                        type: "string",
+                        const: "cat",
+                    },
+                ],
+            };
+            const context = { type: "request" };
+            const result = (0, createSchemaExample_1.sampleFromSchema)(schema, context);
+            expect(result).toBe("dog");
+        });
+    });
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-1069",
+  "version": "0.0.0-1073",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -65,5 +65,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "68650d41c8460a20c228d851f869e495c5608796"
+  "gitHead": "d6c29401ee71e04536c4ece3054c414a79e750da"
 }

package/src/openapi/createSchemaExample.test.ts

@@ -0,0 +1,57 @@
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import { sampleFromSchema } from "./createSchemaExample";
+import { SchemaObject } from "./types";
+
+describe("sampleFromSchema", () => {
+  describe("const support", () => {
+    it("should return default string value when const is not present", () => {
+      const schema: SchemaObject = {
+        type: "string",
+      };
+      const context = { type: "request" as const };
+
+      const result = sampleFromSchema(schema, context);
+
+      expect(result).toBe("string");
+    });
+
+    it("should return const value when const is present", () => {
+      const schema: SchemaObject = {
+        type: "string",
+        const: "example",
+      };
+      const context = { type: "request" as const };
+
+      const result = sampleFromSchema(schema, context);
+
+      expect(result).toBe("example");
+    });
+
+    it("should handle anyOf with const values", () => {
+      const schema: SchemaObject = {
+        type: "string",
+        anyOf: [
+          {
+            type: "string",
+            const: "dog",
+          },
+          {
+            type: "string",
+            const: "cat",
+          },
+        ],
+      };
+      const context = { type: "request" as const };
+
+      const result = sampleFromSchema(schema, context);
+
+      expect(result).toBe("dog");
+    });
+  });
+});

package/src/openapi/createSchemaExample.ts

@@ -111,7 +111,16 @@ export const sampleFromSchema = (
   try {
     // deep copy schema before processing
     let schemaCopy = JSON.parse(JSON.stringify(schema));
-    let { type, example, allOf, properties, items, oneOf, anyOf } = schemaCopy;
+    let {
+      type,
+      example,
+      allOf,
+      properties,
+      items,
+      oneOf,
+      anyOf,
+      const: constant,
+    } = schemaCopy;
 
     if (example !== undefined) {
       return example;
@@ -218,6 +227,10 @@ export const sampleFromSchema = (
       return undefined;
     }
 
+    if (constant) {
+      return constant;
+    }
+
     return primitive(schemaCopy);
   } catch (err) {
     console.error(