fix(schema): allow declaring Returns.Header response without defined …

…value
tsedio · Mar 26, 2024 · d7b9df2 · d7b9df2
1 parent 2cd76dd
commit d7b9df2
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 3 deletions.
diff --git a/packages/specs/schema/src/decorators/operations/returns.spec.ts b/packages/specs/schema/src/decorators/operations/returns.spec.ts
@@ -197,6 +197,59 @@ describe("@Returns", () => {
         ]
       });
     });
+    it("should declare a return type with headers (openspec - header)", () => {
+      // WHEN
+      class Controller {
+        @OperationPath("POST", "/")
+        @Returns(200, String).Description("description").Header("x-token").Examples({test: "Examples"}).Schema({
+          minLength: 3
+        })
+        method() {}
+      }
+
+      // THEN
+      const spec = getSpec(Controller, {specType: SpecTypes.OPENAPI});
+
+      expect(spec).toEqual({
+        paths: {
+          "/": {
+            post: {
+              operationId: "controllerMethod",
+              parameters: [],
+              responses: {
+                "200": {
+                  content: {
+                    "*/*": {
+                      examples: {
+                        test: "Examples"
+                      },
+                      schema: {
+                        minLength: 3,
+                        type: "string"
+                      }
+                    }
+                  },
+                  description: "description",
+                  headers: {
+                    "x-token": {
+                      schema: {
+                        type: "string"
+                      }
+                    }
+                  }
+                }
+              },
+              tags: ["Controller"]
+            }
+          }
+        },
+        tags: [
+          {
+            name: "Controller"
+          }
+        ]
+      });
+    });
     it("should declare a return type with content-type", () => {
       // WHEN
       class Controller {

diff --git a/packages/specs/schema/src/decorators/operations/returns.ts b/packages/specs/schema/src/decorators/operations/returns.ts
@@ -105,7 +105,7 @@ export interface ReturnsChainedDecorators {
    * @param key
    * @param value
    */
-  Header(key: string, value: number | string | (JsonHeader & {value?: string | number | boolean})): this;
+  Header(key: string, value?: number | string | (JsonHeader & {value?: string | number | boolean})): this;
 
   /**
    * Add headers
@@ -227,8 +227,12 @@ class ReturnDecoratorContext extends DecoratorContext<ReturnsChainedDecorators>
     return this;
   }
 
-  header(key: string, value: string | JsonHeader) {
-    return this.headers({[key]: value});
+  header(key: string, value?: string | JsonHeader) {
+    if (value === undefined && isString(key)) {
+      return this.headers({[key]: {type: "string"}});
+    }
+
+    return this.headers({[key]: value!});
   }
 
   location(path: string, meta: JsonHeaders = {}) {