Merge pull request microsoft#8 from mikekistler/mdk/fix-openapi3-resp…

…onse-headers Fix generation of openapi3 response headers
markcowl · Oct 23, 2021 · 5ce4bfd · 5ce4bfd
2 parents d649b44 + a03572e
commit 5ce4bfd
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 3 deletions.
diff --git a/common/changes/@cadl-lang/openapi3/mdk-fix-openapi3-response-headers_2021-10-22-20-08.json b/common/changes/@cadl-lang/openapi3/mdk-fix-openapi3-response-headers_2021-10-22-20-08.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cadl-lang/openapi3",
+      "comment": "Fix generation of openapi3 response headers",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@cadl-lang/openapi3"
+}
diff --git a/packages/openapi3/src/openapi.ts b/packages/openapi3/src/openapi.ts
@@ -405,6 +405,7 @@ function createOAPIEmitter(program: Program, options: OpenAPIEmitterOptions) {
 
     let contentType = "application/json";
     let contentEntry: any = {};
+    let headers: any = {};
 
     let bodyModel = responseModel;
     if (responseModel.kind === "Model") {
@@ -433,9 +434,7 @@ function createOAPIEmitter(program: Program, options: OpenAPIEmitterOptions) {
             }
             break;
           default:
-            const header = getResponseHeader(prop);
-            contentEntry.headers = contentEntry.headers ?? {};
-            contentEntry.headers[headerName] = header;
+            headers[headerName] = getResponseHeader(prop);
             break;
         }
       }
@@ -449,6 +448,9 @@ function createOAPIEmitter(program: Program, options: OpenAPIEmitterOptions) {
         [contentType]: contentEntry,
       },
     };
+    if (Object.keys(headers).length > 0) {
+      response.headers = headers;
+    }
     currentEndpoint.responses[statusCode] = response;
   }
 

diff --git a/packages/openapi3/test/test-openapi-output.ts b/packages/openapi3/test/test-openapi-output.ts
@@ -414,6 +414,28 @@ describe("openapi3: operations", () => {
   });
 });
 
+describe("openapi3: responses", () => {
+  it("define responses with response headers", async () => {
+    const res = await openApiFor(
+      `
+      model ETagHeader {
+        @header eTag: string;
+      }
+      model Key {
+        key: string;
+      }
+      @resource("/")
+      namespace root {
+        @get()
+        op read(): Key & ETagHeader;
+      }
+      `
+    );
+    ok(res.paths["/"].get.responses["200"].headers);
+    ok(res.paths["/"].get.responses["200"].headers["e-tag"]);
+  });
+});
+
 async function oapiForModel(name: string, modelDef: string) {
   const oapi = await openApiFor(`
     ${modelDef};