oas 17.1.5 → 17.1.6

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## <small>17.1.6 (2021-11-29)</small>
+
+* fix: exposing response header descriptions in response json schema (#541) ([d6abf9e](https://github.com/readmeio/oas/commit/d6abf9e)), closes [#541](https://github.com/readmeio/oas/issues/541)
+
+
+
 ## <small>17.1.5 (2021-11-22)</small>
 
 * fix: don't fail to dereference if the api definition is nullish ([e1e33a6](https://github.com/readmeio/oas/commit/e1e33a6))

package/dist/operation/get-response-as-json-schema.js

@@ -22,6 +22,9 @@ function buildHeadersSchema(response) {
             //    This means they can have content instead of schema.
             //    We should probably support that in the future
             headersSchema.properties[key] = toJSONSchema(headers[key].schema);
+            if (headers[key].description) {
+                headersSchema.properties[key].description = headers[key].description;
+            }
         }
     });
     var headersWrapper = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "17.1.5",
+  "version": "17.1.6",
   "description": "Working with OpenAPI definitions is hard. This makes it easier.",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",

package/src/operation/get-response-as-json-schema.js

@@ -25,6 +25,9 @@ function buildHeadersSchema(response) {
       //    This means they can have content instead of schema.
       //    We should probably support that in the future
       headersSchema.properties[key] = toJSONSchema(headers[key].schema);
+      if (headers[key].description) {
+        headersSchema.properties[key].description = headers[key].description;
+      }
     }
   });