oas 17.7.3 → 17.8.2

package/@types/operation.d.ts

@@ -1,6 +1,7 @@
 import type { RequestBodyExamples } from './operation/get-requestbody-examples';
 import type { CallbackExamples } from './operation/get-callback-examples';
 import type { ResponseExamples } from './operation/get-response-examples';
+import type { SchemaWrapper } from './operation/get-parameters-as-json-schema';
 import * as RMOAS from './rmoas.types';
 declare type SecurityType = 'Basic' | 'Bearer' | 'Query' | 'Header' | 'Cookie' | 'OAuth2' | 'http' | 'apiKey';
 export default class Operation {
@@ -43,6 +44,10 @@ export default class Operation {
         request: string[];
         response: string[];
     };
+    /**
+     * All parameters and request bodies converted into JSON Schema.
+     */
+    parameterJsonSchema: SchemaWrapper[];
     constructor(api: RMOAS.OASDocument, path: string, method: RMOAS.HttpMethods, operation: RMOAS.OperationObject);
     getSummary(): string;
     getDescription(): string;
@@ -84,11 +89,15 @@ export default class Operation {
      */
     hasOperationId(): boolean;
     /**
-     * Get an `operationId` for this operation. If one is not present (it's not required by the spec!) a hash of the path
-     * and method will be returned instead.
+     * Get an `operationId` for this operation. If one is not present (it's not required by the spec!)
+     * a hash of the path and method will be returned instead.
      *
+     * @param opts
+     * @param opts.camelCase Generate a JS method-friendly operation ID when one isn't present.
      */
-    getOperationId(): string;
+    getOperationId(opts?: {
+        camelCase: boolean;
+    }): string;
     /**
      * Return an array of all tags, and their metadata, that exist on this operation.
      *
@@ -109,13 +118,18 @@ export default class Operation {
      *
      */
     getParameters(): RMOAS.ParameterObject[];
+    /**
+     * Determine if this operation has any required parameters.
+     *
+     */
+    hasRequiredParameters(): boolean;
     /**
      * Convert the operation into an array of JSON Schema schemas for each available type of parameter available on the
      * operation.
      *
      * @param globalDefaults Contains an object of user defined schema defaults.
      */
-    getParametersAsJsonSchema(globalDefaults?: Record<string, unknown>): import("./operation/get-parameters-as-json-schema").SchemaWrapper[];
+    getParametersAsJsonSchema(globalDefaults?: Record<string, unknown>): SchemaWrapper[];
     /**
      * Get a single response for this status code, formatted as JSON schema.
      *
@@ -144,6 +158,11 @@ export default class Operation {
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#mediaTypeObject}
      */
     getRequestBodyMediaTypes(): string[];
+    /**
+     * Determine if this operation has a required request body.
+     *
+     */
+    hasRequiredRequestBody(): boolean;
     /**
      * Retrieve a specific request body content schema off this operation.
      *

package/CHANGELOG.md

@@ -1,3 +1,37 @@
+## <small>17.8.2 (2022-03-21)</small>
+
+* fix: issue where hostname server variables wouldn't match subdomains or ports (#623) ([0630600](https://github.com/readmeio/oas/commit/0630600)), closes [#623](https://github.com/readmeio/oas/issues/623)
+
+
+
+## <small>17.8.1 (2022-03-04)</small>
+
+* fix: typo in the `--pattern` option ([42db80a](https://github.com/readmeio/oas/commit/42db80a))
+* feat: adding new accessors for determining if an operation has required params (#615) ([c081d92](https://github.com/readmeio/oas/commit/c081d92)), closes [#615](https://github.com/readmeio/oas/issues/615)
+* feat: optionally generate friendlier operationIds (#602) ([6826164](https://github.com/readmeio/oas/commit/6826164)), closes [#602](https://github.com/readmeio/oas/issues/602)
+
+
+
+## 17.8.0 (2022-03-02)
+
+* chore(deps-dev): bump @commitlint/cli from 16.1.0 to 16.2.1 (#612) ([e7364dd](https://github.com/readmeio/oas/commit/e7364dd)), closes [#612](https://github.com/readmeio/oas/issues/612)
+* chore(deps-dev): bump @commitlint/config-conventional (#607) ([5451921](https://github.com/readmeio/oas/commit/5451921)), closes [#607](https://github.com/readmeio/oas/issues/607)
+* chore(deps-dev): bump @readme/eslint-config from 8.4.1 to 8.4.4 (#609) ([7d097f3](https://github.com/readmeio/oas/commit/7d097f3)), closes [#609](https://github.com/readmeio/oas/issues/609)
+* chore(deps-dev): bump @types/jest from 27.4.0 to 27.4.1 (#611) ([ed2b0a3](https://github.com/readmeio/oas/commit/ed2b0a3)), closes [#611](https://github.com/readmeio/oas/issues/611)
+* chore(deps-dev): bump eslint from 8.8.0 to 8.10.0 (#610) ([2382b87](https://github.com/readmeio/oas/commit/2382b87)), closes [#610](https://github.com/readmeio/oas/issues/610)
+* chore(deps-dev): bump eslint-plugin-jsdoc from 37.7.1 to 37.9.5 (#613) ([456bc79](https://github.com/readmeio/oas/commit/456bc79)), closes [#613](https://github.com/readmeio/oas/issues/613)
+* chore(deps-dev): bump jest from 27.4.7 to 27.5.1 (#608) ([41c09f6](https://github.com/readmeio/oas/commit/41c09f6)), closes [#608](https://github.com/readmeio/oas/issues/608)
+* chore(deps-dev): bump typescript from 4.5.5 to 4.6.2 (#605) ([93216ea](https://github.com/readmeio/oas/commit/93216ea)), closes [#605](https://github.com/readmeio/oas/issues/605)
+* chore(deps): bump actions/checkout from 2.4.0 to 3 (#606) ([ea8a28a](https://github.com/readmeio/oas/commit/ea8a28a)), closes [#606](https://github.com/readmeio/oas/issues/606)
+* chore(deps): bump actions/setup-node from 2.5.1 to 3 (#604) ([a463050](https://github.com/readmeio/oas/commit/a463050)), closes [#604](https://github.com/readmeio/oas/issues/604)
+* chore(style): upgrading our core typescript code standards (#598) ([f12d472](https://github.com/readmeio/oas/commit/f12d472)), closes [#598](https://github.com/readmeio/oas/issues/598)
+* feat: adding a dereference option to preserve ref pointers as titles (#601) ([161aebf](https://github.com/readmeio/oas/commit/161aebf)), closes [#601](https://github.com/readmeio/oas/issues/601)
+* feat: upgrading swagger-inline and adding new `pathGlob` and `pattern` options (#614) ([a7dbe6a](https://github.com/readmeio/oas/commit/a7dbe6a)), closes [#614](https://github.com/readmeio/oas/issues/614)
+* build: 17.7.3 release ([0c9974c](https://github.com/readmeio/oas/commit/0c9974c))
+* test: colocating the testing tsconfig with the tests (#599) ([8919177](https://github.com/readmeio/oas/commit/8919177)), closes [#599](https://github.com/readmeio/oas/issues/599)
+
+
+
 ## <small>17.7.3 (2022-02-15)</small>
 
 * feat: adding a dereference option to preserve ref pointers as titles (#601) ([161aebf](https://github.com/readmeio/oas/commit/161aebf)), closes [#601](https://github.com/readmeio/oas/issues/601)

package/dist/index.js

@@ -12,7 +12,11 @@ var __assign = (this && this.__assign) || function () {
 };
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -80,6 +84,7 @@ exports.Callback = operation_1.Callback;
 exports.Webhook = operation_1.Webhook;
 var utils_1 = __importStar(require("./utils"));
 exports.utils = utils_1["default"];
+var SERVER_VARIABLE_REGEX = /{([-_a-zA-Z0-9:.[\]]+)}/g;
 function ensureProtocol(url) {
     // Add protocol to urls starting with // e.g. //example.com
     // This is because httpsnippet throws a HARError when it doesnt have a protocol
@@ -133,12 +138,12 @@ function normalizedUrl(api, selected) {
  *
  * For example, when given `https://{region}.node.example.com/v14` this will return back:
  *
- *    https://([-_a-zA-Z0-9[\\]]+).node.example.com/v14
+ *    https://([-_a-zA-Z0-9:.[\\]]+).node.example.com/v14
  *
  * @param url URL to transform
  */
 function transformUrlIntoRegex(url) {
-    return stripTrailingSlash(url.replace(/{([-_a-zA-Z0-9[\]]+)}/g, '([-_a-zA-Z0-9[\\]]+)'));
+    return stripTrailingSlash(url.replace(SERVER_VARIABLE_REGEX, '([-_a-zA-Z0-9:.[\\]]+)'));
 }
 /**
  * Normalize a path so that we can use it with `path-to-regexp` to do operation lookups.
@@ -358,7 +363,7 @@ var Oas = /** @class */ (function () {
             // way we'll be able to extract the parameter names and match them up with the matched server that we obtained
             // above.
             var variables = {};
-            Array.from(server.url.matchAll(/{([-_a-zA-Z0-9[\]]+)}/g)).forEach(function (variable, y) {
+            Array.from(server.url.matchAll(SERVER_VARIABLE_REGEX)).forEach(function (variable, y) {
                 variables[variable[1]] = found[y + 1];
             });
             return {
@@ -392,7 +397,7 @@ var Oas = /** @class */ (function () {
         if (variables === void 0) { variables = {}; }
         // When we're constructing URLs, server URLs with trailing slashes cause problems with doing lookups, so if we have
         // one here on, slice it off.
-        return stripTrailingSlash(url.replace(/{([-_a-zA-Z0-9[\]]+)}/g, function (original, key) {
+        return stripTrailingSlash(url.replace(SERVER_VARIABLE_REGEX, function (original, key) {
             var userVariable = (0, get_user_variable_1["default"])(_this.user, key);
             if (userVariable) {
                 return userVariable;

package/dist/lib/dedupe-common-parameters.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/lib/openapi-to-json-schema.js

@@ -12,7 +12,11 @@ var __assign = (this && this.__assign) || function () {
 };
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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

@@ -12,7 +12,11 @@ var __assign = (this && this.__assign) || function () {
 };
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/operation.js

@@ -16,7 +16,11 @@ var __extends = (this && this.__extends) || (function () {
 })();
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -282,20 +286,33 @@ var Operation = /** @class */ (function () {
         return 'operationId' in this.schema;
     };
     /**
-     * Get an `operationId` for this operation. If one is not present (it's not required by the spec!) a hash of the path
-     * and method will be returned instead.
+     * Get an `operationId` for this operation. If one is not present (it's not required by the spec!)
+     * a hash of the path and method will be returned instead.
      *
+     * @param opts
+     * @param opts.camelCase Generate a JS method-friendly operation ID when one isn't present.
      */
-    Operation.prototype.getOperationId = function () {
+    Operation.prototype.getOperationId = function (opts) {
         if ('operationId' in this.schema) {
             return this.schema.operationId;
         }
-        var url = this.path
+        var method = this.method.toLowerCase();
+        var operationId = this.path
             .replace(/[^a-zA-Z0-9]/g, '-') // Remove weird characters
             .replace(/^-|-$/g, '') // Don't start or end with -
             .replace(/--+/g, '-') // Remove double --'s
             .toLowerCase();
-        return "".concat(this.method.toLowerCase(), "_").concat(url);
+        if (opts === null || opts === void 0 ? void 0 : opts.camelCase) {
+            operationId = operationId.replace(/[^a-zA-Z0-9]+(.)/g, function (_, chr) { return chr.toUpperCase(); });
+            // If the generated operationId already starts with the method (eg. `getPets`) we don't want
+            // to double it up into `getGetPets`.
+            if (operationId.startsWith(method)) {
+                return operationId;
+            }
+            operationId = operationId.charAt(0).toUpperCase() + operationId.slice(1);
+            return "".concat(method).concat(operationId);
+        }
+        return "".concat(method, "_").concat(operationId);
     };
     /**
      * Return an array of all tags, and their metadata, that exist on this operation.
@@ -354,6 +371,13 @@ var Operation = /** @class */ (function () {
         }
         return parameters;
     };
+    /**
+     * Determine if this operation has any required parameters.
+     *
+     */
+    Operation.prototype.hasRequiredParameters = function () {
+        return this.getParameters().some(function (param) { return 'required' in param && param.required; });
+    };
     /**
      * Convert the operation into an array of JSON Schema schemas for each available type of parameter available on the
      * operation.
@@ -361,7 +385,11 @@ var Operation = /** @class */ (function () {
      * @param globalDefaults Contains an object of user defined schema defaults.
      */
     Operation.prototype.getParametersAsJsonSchema = function (globalDefaults) {
-        return (0, get_parameters_as_json_schema_1["default"])(this, this.api, globalDefaults);
+        if (this.parameterJsonSchema) {
+            return this.parameterJsonSchema;
+        }
+        this.parameterJsonSchema = (0, get_parameters_as_json_schema_1["default"])(this, this.api, globalDefaults);
+        return this.parameterJsonSchema;
     };
     /**
      * Get a single response for this status code, formatted as JSON schema.
@@ -403,6 +431,33 @@ var Operation = /** @class */ (function () {
         }
         return Object.keys(requestBody.content);
     };
+    /**
+     * Determine if this operation has a required request body.
+     *
+     */
+    Operation.prototype.hasRequiredRequestBody = function () {
+        if (!this.hasRequestBody()) {
+            return false;
+        }
+        var requestBody = this.schema.requestBody;
+        if (RMOAS.isRef(requestBody)) {
+            return false;
+        }
+        if (requestBody.required) {
+            return true;
+        }
+        // The OpenAPI spec isn't clear on the differentiation between schema `required` and
+        // `requestBody.required` because you can have required top-level schema properties but a
+        // non-required requestBody that negates each other.
+        //
+        // To kind of work ourselves around this and present a better QOL for this accessor, if at this
+        // final point where we don't have a required request body, but the underlying Media Type Object
+        // schema says that it has required properties then we should ultimately recognize that this
+        // request body is required -- even as the request body description says otherwise.
+        return !!this.getParametersAsJsonSchema()
+            .filter(function (js) { return ['body', 'formData'].includes(js.type); })
+            .find(function (js) { return js.schema && Array.isArray(js.schema.required) && js.schema.required.length; });
+    };
     /**
      * Retrieve a specific request body content schema off this operation.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "17.7.3",
+  "version": "17.8.2",
   "description": "Working with OpenAPI definitions is hard. This makes it easier.",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",
@@ -62,7 +62,7 @@
     "oas-normalize": "^5.1.1",
     "openapi-types": "^10.0.0",
     "path-to-regexp": "^6.2.0",
-    "swagger-inline": "^5.0.2"
+    "swagger-inline": "^5.1.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^16.0.1",

package/src/cli/lib/utils.js

@@ -44,17 +44,20 @@ exports.findSwagger = async function (info, cb) {
     process.exit(1);
   }
 
-  let pathGlob = '**/*';
+  let pathGlob = info.opts.pathGlob || '**/*';
   if (info.opts.path) {
     pathGlob = `${info.opts.path.replace(/\/$/, '')}/*`;
   }
 
-  const generatedDefinition = await swaggerInline(pathGlob, { format: '.json', scope: info.opts.scope, base }).catch(
-    err => {
-      console.error(err);
-      process.exit(1);
-    }
-  );
+  const generatedDefinition = await swaggerInline(pathGlob, {
+    format: '.json',
+    scope: info.opts.scope,
+    base,
+    pattern: info.opts.pattern || null,
+  }).catch(err => {
+    console.error(err);
+    process.exit(1);
+  });
 
   let oas = new OASNormalize(generatedDefinition);
   const bundledDefinition = await oas.bundle().catch(err => {

package/src/index.ts

@@ -24,6 +24,8 @@ type PathMatches = PathMatch[];
 
 type Variables = Record<string, string | number | { default?: string | number }[] | { default?: string | number }>;
 
+const SERVER_VARIABLE_REGEX = /{([-_a-zA-Z0-9:.[\]]+)}/g;
+
 function ensureProtocol(url: string) {
   // Add protocol to urls starting with // e.g. //example.com
   // This is because httpsnippet throws a HARError when it doesnt have a protocol
@@ -84,12 +86,12 @@ function normalizedUrl(api: RMOAS.OASDocument, selected: number) {
  *
  * For example, when given `https://{region}.node.example.com/v14` this will return back:
  *
- *    https://([-_a-zA-Z0-9[\\]]+).node.example.com/v14
+ *    https://([-_a-zA-Z0-9:.[\\]]+).node.example.com/v14
  *
  * @param url URL to transform
  */
 function transformUrlIntoRegex(url: string) {
-  return stripTrailingSlash(url.replace(/{([-_a-zA-Z0-9[\]]+)}/g, '([-_a-zA-Z0-9[\\]]+)'));
+  return stripTrailingSlash(url.replace(SERVER_VARIABLE_REGEX, '([-_a-zA-Z0-9:.[\\]]+)'));
 }
 
 /**
@@ -365,7 +367,7 @@ export default class Oas {
         // way we'll be able to extract the parameter names and match them up with the matched server that we obtained
         // above.
         const variables: Record<string, string | number> = {};
-        Array.from(server.url.matchAll(/{([-_a-zA-Z0-9[\]]+)}/g)).forEach((variable, y) => {
+        Array.from(server.url.matchAll(SERVER_VARIABLE_REGEX)).forEach((variable, y) => {
           variables[variable[1]] = found[y + 1];
         });
 
@@ -401,7 +403,7 @@ export default class Oas {
     // When we're constructing URLs, server URLs with trailing slashes cause problems with doing lookups, so if we have
     // one here on, slice it off.
     return stripTrailingSlash(
-      url.replace(/{([-_a-zA-Z0-9[\]]+)}/g, (original: string, key: string) => {
+      url.replace(SERVER_VARIABLE_REGEX, (original: string, key: string) => {
         const userVariable = getUserVariable(this.user, key);
         if (userVariable) {
           return userVariable as string;

package/src/operation.ts

@@ -2,6 +2,7 @@ import type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
 import type { RequestBodyExamples } from './operation/get-requestbody-examples';
 import type { CallbackExamples } from './operation/get-callback-examples';
 import type { ResponseExamples } from './operation/get-response-examples';
+import type { SchemaWrapper } from './operation/get-parameters-as-json-schema';
 
 import * as RMOAS from './rmoas.types';
 import dedupeCommonParameters from './lib/dedupe-common-parameters';
@@ -65,6 +66,11 @@ export default class Operation {
     response: string[];
   };
 
+  /**
+   * All parameters and request bodies converted into JSON Schema.
+   */
+  parameterJsonSchema: SchemaWrapper[];
+
   constructor(api: RMOAS.OASDocument, path: string, method: RMOAS.HttpMethods, operation: RMOAS.OperationObject) {
     this.schema = operation;
     this.api = api;
@@ -323,22 +329,38 @@ export default class Operation {
   }
 
   /**
-   * Get an `operationId` for this operation. If one is not present (it's not required by the spec!) a hash of the path
-   * and method will be returned instead.
+   * Get an `operationId` for this operation. If one is not present (it's not required by the spec!)
+   * a hash of the path and method will be returned instead.
    *
+   * @param opts
+   * @param opts.camelCase Generate a JS method-friendly operation ID when one isn't present.
    */
-  getOperationId(): string {
+  getOperationId(opts?: { camelCase: boolean }): string {
     if ('operationId' in this.schema) {
       return this.schema.operationId;
     }
 
-    const url = this.path
+    const method = this.method.toLowerCase();
+    let operationId = this.path
       .replace(/[^a-zA-Z0-9]/g, '-') // Remove weird characters
       .replace(/^-|-$/g, '') // Don't start or end with -
       .replace(/--+/g, '-') // Remove double --'s
       .toLowerCase();
 
-    return `${this.method.toLowerCase()}_${url}`;
+    if (opts?.camelCase) {
+      operationId = operationId.replace(/[^a-zA-Z0-9]+(.)/g, (_, chr) => chr.toUpperCase());
+
+      // If the generated operationId already starts with the method (eg. `getPets`) we don't want
+      // to double it up into `getGetPets`.
+      if (operationId.startsWith(method)) {
+        return operationId;
+      }
+
+      operationId = operationId.charAt(0).toUpperCase() + operationId.slice(1);
+      return `${method}${operationId}`;
+    }
+
+    return `${method}_${operationId}`;
   }
 
   /**
@@ -405,6 +427,14 @@ export default class Operation {
     return parameters;
   }
 
+  /**
+   * Determine if this operation has any required parameters.
+   *
+   */
+  hasRequiredParameters() {
+    return this.getParameters().some(param => 'required' in param && param.required);
+  }
+
   /**
    * Convert the operation into an array of JSON Schema schemas for each available type of parameter available on the
    * operation.
@@ -412,7 +442,12 @@ export default class Operation {
    * @param globalDefaults Contains an object of user defined schema defaults.
    */
   getParametersAsJsonSchema(globalDefaults?: Record<string, unknown>) {
-    return getParametersAsJsonSchema(this, this.api, globalDefaults);
+    if (this.parameterJsonSchema) {
+      return this.parameterJsonSchema;
+    }
+
+    this.parameterJsonSchema = getParametersAsJsonSchema(this, this.api, globalDefaults);
+    return this.parameterJsonSchema;
   }
 
   /**
@@ -461,6 +496,37 @@ export default class Operation {
     return Object.keys(requestBody.content);
   }
 
+  /**
+   * Determine if this operation has a required request body.
+   *
+   */
+  hasRequiredRequestBody() {
+    if (!this.hasRequestBody()) {
+      return false;
+    }
+
+    const requestBody = this.schema.requestBody;
+    if (RMOAS.isRef(requestBody)) {
+      return false;
+    }
+
+    if (requestBody.required) {
+      return true;
+    }
+
+    // The OpenAPI spec isn't clear on the differentiation between schema `required` and
+    // `requestBody.required` because you can have required top-level schema properties but a
+    // non-required requestBody that negates each other.
+    //
+    // To kind of work ourselves around this and present a better QOL for this accessor, if at this
+    // final point where we don't have a required request body, but the underlying Media Type Object
+    // schema says that it has required properties then we should ultimately recognize that this
+    // request body is required -- even as the request body description says otherwise.
+    return !!this.getParametersAsJsonSchema()
+      .filter(js => ['body', 'formData'].includes(js.type))
+      .find(js => js.schema && Array.isArray(js.schema.required) && js.schema.required.length);
+  }
+
   /**
    * Retrieve a specific request body content schema off this operation.
    *

package/tsconfig.test.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "module": "es6",
-    "moduleResolution": "node",
-    "noImplicitAny": false,
-  },
-  "include": ["src/**/*", "__tests__/**/*"]
-}