oas 20.3.0 → 20.4.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 20.4.0 (2023-01-12)
+
+* feat: pass through requestBody descriptions (#730) ([3272137](https://github.com/readmeio/oas/commit/3272137)), closes [#730](https://github.com/readmeio/oas/issues/730)
+
+
+
 ## 20.3.0 (2023-01-03)
 
 * chore: bumping deps ([ed5e473](https://github.com/readmeio/oas/commit/ed5e473))

package/dist/operation/get-parameters-as-json-schema.d.ts

@@ -5,6 +5,7 @@ export interface SchemaWrapper {
     type: string;
     label?: string;
     schema: SchemaObject;
+    description?: string;
     deprecatedProps?: SchemaWrapper;
 }
 /**

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

@@ -127,7 +127,7 @@ function getParametersAsJSONSchema(operation, api, opts) {
         var requestBody = operation.getRequestBody();
         if (!requestBody || !Array.isArray(requestBody))
             return null;
-        var mediaType = requestBody[0], mediaTypeObject = requestBody[1];
+        var mediaType = requestBody[0], mediaTypeObject = requestBody[1], description = requestBody[2];
         var type = mediaType === 'application/x-www-form-urlencoded' ? 'formData' : 'body';
         // If this schema is completely empty, don't bother processing it.
         if (!mediaTypeObject.schema || !Object.keys(mediaTypeObject.schema).length) {
@@ -157,14 +157,9 @@ function getParametersAsJSONSchema(operation, api, opts) {
         if (!Object.keys(cleanedSchema).length) {
             return null;
         }
-        return {
-            type: type,
-            label: exports.types[type],
-            schema: (0, openapi_to_json_schema_1.isPrimitive)(cleanedSchema)
+        return __assign({ type: type, label: exports.types[type], schema: (0, openapi_to_json_schema_1.isPrimitive)(cleanedSchema)
                 ? cleanedSchema
-                : __assign(__assign({}, cleanedSchema), { $schema: (0, openapi_to_json_schema_1.getSchemaVersionString)(cleanedSchema, api) }),
-            deprecatedProps: getDeprecated(cleanedSchema, type)
-        };
+                : __assign(__assign({}, cleanedSchema), { $schema: (0, openapi_to_json_schema_1.getSchemaVersionString)(cleanedSchema, api) }), deprecatedProps: getDeprecated(cleanedSchema, type) }, (description ? { description: description } : {}));
     }
     function transformComponents() {
         if (!('components' in api)) {

package/dist/operation.d.ts

@@ -210,7 +210,7 @@ export default class Operation {
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#mediaTypeObject}
      * @param mediaType Specific request body media type to retrieve if present.
      */
-    getRequestBody(mediaType?: string): false | RMOAS.MediaTypeObject | [string, RMOAS.MediaTypeObject];
+    getRequestBody(mediaType?: string): false | RMOAS.MediaTypeObject | [string, RMOAS.MediaTypeObject, ...string[]];
     /**
      * Retrieve an array of request body examples that this operation has.
      *

package/dist/operation.js

@@ -48,6 +48,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -543,7 +552,10 @@ var Operation = /** @class */ (function () {
             });
         }
         if (availableMediaType) {
-            return [availableMediaType, requestBody.content[availableMediaType]];
+            return __spreadArray([
+                availableMediaType,
+                requestBody.content[availableMediaType]
+            ], (requestBody.description ? [requestBody.description] : []), true);
         }
         return false;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "20.3.0",
+  "version": "20.4.0",
   "description": "Comprehensive tooling for working with OpenAPI definitions",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",

package/src/operation/get-parameters-as-json-schema.ts

@@ -13,6 +13,7 @@ export interface SchemaWrapper {
   type: string;
   label?: string;
   schema: SchemaObject;
+  description?: string;
   deprecatedProps?: SchemaWrapper;
 }
 
@@ -124,7 +125,7 @@ export default function getParametersAsJSONSchema(
     const requestBody = operation.getRequestBody();
     if (!requestBody || !Array.isArray(requestBody)) return null;
 
-    const [mediaType, mediaTypeObject] = requestBody;
+    const [mediaType, mediaTypeObject, description] = requestBody;
     const type = mediaType === 'application/x-www-form-urlencoded' ? 'formData' : 'body';
 
     // If this schema is completely empty, don't bother processing it.
@@ -146,6 +147,7 @@ export default function getParametersAsJSONSchema(
     // We're cloning the request schema because we've had issues with request schemas that were
     // dereferenced being processed multiple times because their component is also processed.
     const requestSchema = cloneObject(mediaTypeObject.schema);
+
     const cleanedSchema = toJSONSchema(requestSchema, {
       globalDefaults: opts.globalDefaults,
       prevSchemas,
@@ -168,6 +170,7 @@ export default function getParametersAsJSONSchema(
             $schema: getSchemaVersionString(cleanedSchema, api),
           },
       deprecatedProps: getDeprecated(cleanedSchema, type),
+      ...(description ? { description } : {}),
     };
   }
 

package/src/operation.ts

@@ -621,7 +621,7 @@ export default class Operation {
    * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#mediaTypeObject}
    * @param mediaType Specific request body media type to retrieve if present.
    */
-  getRequestBody(mediaType?: string): false | RMOAS.MediaTypeObject | [string, RMOAS.MediaTypeObject] {
+  getRequestBody(mediaType?: string): false | RMOAS.MediaTypeObject | [string, RMOAS.MediaTypeObject, ...string[]] {
     if (!this.hasRequestBody()) {
       return false;
     }
@@ -660,7 +660,11 @@ export default class Operation {
     }
 
     if (availableMediaType) {
-      return [availableMediaType, requestBody.content[availableMediaType]];
+      return [
+        availableMediaType,
+        requestBody.content[availableMediaType],
+        ...(requestBody.description ? [requestBody.description] : []),
+      ];
     }
 
     return false;