fix(schema): fix issue when oneOf & discriminator have no children class

tsedio · Jan 11, 2023 · 2488f60 · 2488f60
1 parent 0a82fad
commit 2488f60
Show file tree

Hide file tree

Showing 3 changed files with 109 additions and 0 deletions.
diff --git a/packages/specs/schema/src/decorators/common/oneOf.spec.ts b/packages/specs/schema/src/decorators/common/oneOf.spec.ts
@@ -28,6 +28,39 @@ describe("@OneOf", () => {
       type: "object"
     });
   });
+  it("should declare return schema for only one model", () => {
+    // WHEN
+    class Nested {
+      @Property()
+      id: string;
+    }
+    class Model {
+      @OneOf(Nested)
+      num: string;
+    }
+
+    // THEN
+    const schema = getJsonSchema(Model);
+
+    expect(schema).toEqual({
+      definitions: {
+        Nested: {
+          properties: {
+            id: {
+              type: "string"
+            }
+          },
+          type: "object"
+        }
+      },
+      properties: {
+        num: {
+          $ref: "#/definitions/Nested"
+        }
+      },
+      type: "object"
+    });
+  });
   it("should declare two models", () => {
     class One1 {
       @Property()

diff --git a/packages/specs/schema/src/domain/JsonSchema.ts b/packages/specs/schema/src/domain/JsonSchema.ts
@@ -640,6 +640,10 @@ export class JsonSchema extends Map<string, any> implements NestedGenerics {
 
       const children = resolvedOneOf[0].discriminator().children();
 
+      if (!children.length) {
+        return this.type(oneOf[0]);
+      }
+
       resolvedOneOf = children.map(mapToJsonSchema);
     }
 

diff --git a/packages/specs/schema/test/discriminator.integration.spec.ts b/packages/specs/schema/test/discriminator.integration.spec.ts
@@ -14,6 +14,7 @@ import {
   Required,
   Returns
 } from "@tsed/schema";
+import Base = Mocha.reporters.Base;
 
 class Event {
   @DiscriminatorKey() // declare this property a discriminator key
@@ -782,6 +783,77 @@ describe("Discriminator", () => {
         ]
       });
     });
+    it("should generate the spec (return no item)", () => {
+      class Base {
+        @DiscriminatorKey() // declare this property a discriminator key
+        type: string;
+
+        @Property()
+        value: string;
+      }
+
+      @Controller("/")
+      class MyTest {
+        @Get("/:id")
+        @Returns(200).OneOf(Base)
+        get(@PathParams(":id") id: string) {
+          return [];
+        }
+      }
+
+      expect(getSpec(MyTest)).toEqual({
+        components: {
+          schemas: {
+            Base: {
+              properties: {
+                type: {
+                  type: "string"
+                },
+                value: {
+                  type: "string"
+                }
+              },
+              type: "object"
+            }
+          }
+        },
+        paths: {
+          "/{id}": {
+            get: {
+              operationId: "myTestGet",
+              parameters: [
+                {
+                  in: "path",
+                  name: "id",
+                  required: true,
+                  schema: {
+                    type: "string"
+                  }
+                }
+              ],
+              responses: {
+                "200": {
+                  content: {
+                    "*/*": {
+                      schema: {
+                        $ref: "#/components/schemas/Base"
+                      }
+                    }
+                  },
+                  description: "Success"
+                }
+              },
+              tags: ["MyTest"]
+            }
+          }
+        },
+        tags: [
+          {
+            name: "MyTest"
+          }
+        ]
+      });
+    });
   });
   describe("isDiscriminatorChild", () => {
     it("should return true when it's a child discriminator", () => {