docusaurus-openapi-docs/packages/docusaurus-plugin-openapi-docs/src/openapi/createSchemaExample.test.ts at 3ec416bf92a3433b0fecb1af665aaa0fd0d788b7 · emmanuel-ferdman/docusaurus-openapi-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/* ============================================================================
 * 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");
    });
  });

  describe("allOf with incompatible types", () => {
    it("should return undefined when allOf contains incompatible types", () => {
      const schema: SchemaObject = {
        allOf: [{ type: "string" }, { type: "integer" }],
      };
      const context = { type: "request" as const };

      const result = sampleFromSchema(schema, context);

      expect(result).toBeUndefined();
    });

    it("should handle incompatible allOf types in a property", () => {
      const schema: SchemaObject = {
        type: "object",
        properties: {
          numero: {
            allOf: [{ type: "string" }, { type: "integer" }],
          },
          name: {
            type: "string",
          },
        },
      };
      const context = { type: "request" as const };

      const result = sampleFromSchema(schema, context);

      expect(result.name).toBe("string");
    });
  });
});