feat(schema): add tests for deprecated param and prop

tsedio · Sep 8, 2022 · d94c1db · d94c1db
1 parent ab4c092
commit d94c1db
Showing 1 changed file with 99 additions and 10 deletions.
diff --git a/packages/specs/schema/src/decorators/operations/deprecated.spec.ts b/packages/specs/schema/src/decorators/operations/deprecated.spec.ts
@@ -1,4 +1,5 @@
-import {Deprecated, getSpec, OperationPath, SpecTypes} from "@tsed/schema";
+import {Deprecated, getSpec, OperationPath, Returns, SpecTypes} from "@tsed/schema";
+import {QueryParams} from "@tsed/platform-params";
 
 describe("Deprecated", () => {
   it("should store metadata (swagger)", () => {
@@ -105,18 +106,106 @@ describe("Deprecated", () => {
       }
     });
   });
-  it("should throw error for unsupported usage", () => {
-    class Test {
-      test() {}
+  it("should store metadata (param)", () => {
+    class MyController {
+      @OperationPath("GET", "/")
+      get(@QueryParams("param") @Deprecated(true) param: string) {}
+    }
+
+    expect(getSpec(MyController)).toEqual({
+      tags: [
+        {
+          name: "MyController"
+        }
+      ],
+      paths: {
+        "/": {
+          get: {
+            operationId: "myControllerGet",
+            parameters: [
+              {
+                deprecated: true,
+                in: "query",
+                name: "param",
+                required: false,
+                schema: {
+                  type: "string"
+                }
+              }
+            ],
+            responses: {
+              "200": {
+                description: "Success"
+              }
+            },
+            tags: ["MyController"]
+          }
+        }
+      }
+    });
+  });
+  it("should store metadata (prop)", () => {
+    class MyModel {
+      @Deprecated()
+      myProp: string;
     }
 
-    let actualError: any;
-    try {
-      Deprecated()(Test.prototype, "test", 0);
-    } catch (er) {
-      actualError = er;
+    class MyController {
+      @OperationPath("GET", "/")
+      @Returns(200, MyModel)
+      get(@QueryParams("param") @Deprecated(true) param: string) {}
     }
 
-    expect(actualError.message).toEqual("Deprecated cannot be used as parameter decorator on Test.test.[0]");
+    expect(getSpec(MyController)).toEqual({
+      tags: [
+        {
+          name: "MyController"
+        }
+      ],
+      paths: {
+        "/": {
+          get: {
+            operationId: "myControllerGet",
+            parameters: [
+              {
+                deprecated: true,
+                in: "query",
+                name: "param",
+                required: false,
+                schema: {
+                  type: "string"
+                }
+              }
+            ],
+            responses: {
+              "200": {
+                description: "Success",
+                content: {
+                  "application/json": {
+                    schema: {
+                      $ref: "#/components/schemas/MyModel"
+                    }
+                  }
+                }
+              }
+            },
+            tags: ["MyController"]
+          }
+        }
+      },
+      components: {
+        schemas: {
+          MyModel: {
+            type: "object",
+            properties: {
+              myProp: {
+                type: "string",
+                deprecated: true
+              }
+            }
+          }
+        }
+      }
+    });
   });
 });