oas 17.7.2 → 17.8.1

package/@types/index.d.ts

@@ -13,10 +13,10 @@ declare type PathMatch = {
     operation: RMOAS.PathsObject;
     match?: MatchResult;
 };
-declare type PathMatches = Array<PathMatch>;
-declare type Variables = Record<string, string | number | Array<{
+declare type PathMatches = PathMatch[];
+declare type Variables = Record<string, string | number | {
     default?: string | number;
-}> | {
+}[] | {
     default?: string | number;
 }>;
 export default class Oas {
@@ -35,10 +35,10 @@ export default class Oas {
      *
      * @todo These are always `Promise.resolve` and `Promise.reject`. Make these types more specific than `any`.
      */
-    protected promises: Array<{
+    protected promises: {
         resolve: any;
         reject: any;
-    }>;
+    }[];
     /**
      * Internal storage array that the library utilizes to keep track of its `dereferencing` state so it doesn't initiate
      * multiple dereferencing processes.
@@ -217,7 +217,10 @@ export default class Oas {
      * Dereference the current OAS definition so it can be parsed free of worries of `$ref` schemas and circular
      * structures.
      *
+     * @param opts
      */
-    dereference(): Promise<unknown>;
+    dereference(opts?: {
+        preserveRefAsJSONSchemaTitle: boolean;
+    }): Promise<unknown>;
 }
 export { Operation, Callback, Webhook, utils };

package/@types/lib/get-schema.d.ts

@@ -11,11 +11,7 @@ import type * as RMOAS from '../rmoas.types';
  * @param operation Operation to look for a primary requestBody schema in.
  * @param api The API definition that this operation exists within.
  */
-export default function getSchema(operation: RMOAS.OperationObject, api?: RMOAS.OASDocument | {
-    [schemaType: string]: {
-        [key: string]: RMOAS.SchemaObject;
-    };
-}): {
+export default function getSchema(operation: RMOAS.OperationObject, api?: RMOAS.OASDocument | Record<string, Record<string, RMOAS.SchemaObject>>): {
     type: string;
     schema: any;
 };

package/@types/lib/openapi-to-json-schema.d.ts

@@ -1,10 +1,8 @@
 import * as RMOAS from '../rmoas.types';
-declare type PrevSchemasType = Array<RMOAS.SchemaObject>;
+declare type PrevSchemasType = RMOAS.SchemaObject[];
 export declare type toJsonSchemaOptions = {
     currentLocation?: string;
-    globalDefaults?: {
-        [key: string]: unknown;
-    };
+    globalDefaults?: Record<string, unknown>;
     isPolymorphicAllOfChild?: boolean;
     prevSchemas?: PrevSchemasType;
     refLogger?: (ref: string) => void;

package/@types/operation/get-callback-examples.d.ts

@@ -1,10 +1,10 @@
 import type * as RMOAS from '../rmoas.types';
-export declare type CallbackExamples = Array<{
+export declare type CallbackExamples = {
     identifier: string;
     expression: string;
     method: string;
     example: unknown;
-}>;
+}[];
 /**
  * With an OpenAPI Operation Object return back a collection of examples for any callbacks that may be present.
  *

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

@@ -14,9 +14,7 @@ export declare type SchemaWrapper = {
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#parameterObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameterObject}
  */
-export declare const types: {
-    [key: keyof RMOAS.OASDocument]: string;
-};
+export declare const types: Record<keyof RMOAS.OASDocument, string>;
 /**
  * @param operation
  * @param api

package/@types/operation/get-requestbody-examples.d.ts

@@ -1,8 +1,8 @@
 import type * as RMOAS from '../rmoas.types';
-export declare type RequestBodyExamples = Array<{
+export declare type RequestBodyExamples = {
     mediaType: string;
     examples: any;
-}>;
+}[];
 /**
  * Retrieve a collection of request body examples, keyed by their media type.
  *

package/@types/operation/get-response-as-json-schema.d.ts

@@ -10,7 +10,7 @@ import type Operation from 'operation';
  * @param statusCode The response status code to generate a schema for.
  */
 export default function getResponseAsJsonSchema(operation: Operation, api: OASDocument, statusCode: string | number): {
-    type: string | Array<string>;
+    type: string | string[];
     schema: SchemaObject;
     label: string;
     description?: string;

package/@types/operation/get-response-examples.d.ts

@@ -1,8 +1,8 @@
 import type * as RMOAS from '../rmoas.types';
-export declare type ResponseExamples = Array<{
+export declare type ResponseExamples = {
     status: string;
     mediaTypes: Record<string, RMOAS.MediaTypeObject>;
-}>;
+}[];
 /**
  * Retrieve a collection of response examples keyed, by their media type.
  *

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 {
@@ -40,9 +41,13 @@ export default class Operation {
      * Flattened out arrays of both request and response headers that are utilized on this operation.
      */
     headers: {
-        request: Array<string>;
-        response: Array<string>;
+        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;
@@ -56,7 +61,7 @@ export default class Operation {
      * level, the securities for the entire API definition are returned (with an empty array as a final fallback).
      *
      */
-    getSecurity(): Array<RMOAS.SecurityRequirementObject>;
+    getSecurity(): RMOAS.SecurityRequirementObject[];
     /**
      * Retrieve a collection of grouped security schemes. The inner array determines and-grouped security schemes, the
      * outer array determines or-groups.
@@ -67,16 +72,16 @@ export default class Operation {
      * @param filterInvalid Optional flag that, when set to `true`, filters out invalid/nonexistent security schemes,
      *    rather than returning `false`.
      */
-    getSecurityWithTypes(filterInvalid?: boolean): Array<false | Array<false | {
+    getSecurityWithTypes(filterInvalid?: boolean): (false | (false | {
         security: RMOAS.KeyedSecuritySchemeObject;
         type: SecurityType;
-    }>>;
+    })[])[];
     /**
      * Retrieve an object where the keys are unique scheme types, and the values are arrays containing each security
      * scheme of that type.
      *
      */
-    prepareSecurity(): Record<SecurityType, Array<RMOAS.KeyedSecuritySchemeObject>>;
+    prepareSecurity(): Record<SecurityType, RMOAS.KeyedSecuritySchemeObject[]>;
     getHeaders(): Operation['headers'];
     /**
      * Determine if the operation has an operation present in its schema.
@@ -84,16 +89,20 @@ 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.
      *
      */
-    getTags(): Array<RMOAS.TagObject>;
+    getTags(): RMOAS.TagObject[];
     /**
      * Return is the operation is flagged as `deprecated` or not.
      *
@@ -108,14 +117,19 @@ export default class Operation {
      * Return the parameters (non-request body) on the operation.
      *
      */
-    getParameters(): Array<RMOAS.ParameterObject>;
+    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.
      *
@@ -131,7 +145,7 @@ export default class Operation {
      * Get an array of all valid response status codes for this operation.
      *
      */
-    getResponseStatusCodes(): Array<string>;
+    getResponseStatusCodes(): string[];
     /**
      * Determine if the operation has any request bodies.
      *
@@ -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.
      *
@@ -191,7 +210,7 @@ export default class Operation {
      * Retrieve an array of operations created from each callback.
      *
      */
-    getCallbacks(): false | Array<false | Callback>;
+    getCallbacks(): false | (false | Callback)[];
     /**
      * Retrieve an array of callback examples that this operation has.
      *
@@ -233,7 +252,7 @@ export declare class Callback extends Operation {
     getIdentifier(): string;
     getSummary(): string;
     getDescription(): string;
-    getParameters(): Array<RMOAS.ParameterObject>;
+    getParameters(): RMOAS.ParameterObject[];
 }
 export declare class Webhook extends Operation {
 }

package/@types/rmoas.types.d.ts

@@ -13,21 +13,19 @@ export declare function isRef(check: unknown): check is OpenAPIV3.ReferenceObjec
 export declare function isOAS31(check: OpenAPIV3.Document | OpenAPIV3_1.Document): check is OpenAPIV3_1.Document;
 export interface User {
     [key: string]: unknown;
-    keys?: Array<{
+    keys?: {
         name: string | number;
         user?: string | number;
         pass?: string | number;
         [key: string]: unknown;
-    }>;
+    }[];
 }
 export declare type HttpMethods = (OpenAPIV3.HttpMethods | OpenAPIV3_1.HttpMethods) | ('get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace');
 /**
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oasObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oasObject}
  */
-export declare type OASDocument = (OpenAPIV3.Document | OpenAPIV3_1.Document) & {
-    [extension: string]: unknown;
-};
+export declare type OASDocument = (OpenAPIV3.Document | OpenAPIV3_1.Document) & Record<string, unknown>;
 /**
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#serverObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#serverObject}
@@ -38,12 +36,10 @@ export declare type ServerObject = OpenAPIV3.ServerObject | OpenAPIV3_1.ServerOb
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#serverVariableObject}
  */
 export declare type ServerVariableObject = OpenAPIV3.ServerVariableObject | OpenAPIV3_1.ServerVariableObject;
-export declare type ServerVariablesObject = {
-    [variable: string]: ServerVariableObject;
-};
-export declare type ServerVariable = Record<string, string | number | Array<{
+export declare type ServerVariablesObject = Record<string, ServerVariableObject>;
+export declare type ServerVariable = Record<string, string | number | {
     default?: string | number;
-}> | {
+}[] | {
     default?: string | number;
 } | Record<string, never>>;
 export declare type Servers = {
@@ -69,9 +65,7 @@ export declare type PathItemObject = OpenAPIV3.PathItemObject | OpenAPIV3_1.Path
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operationObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operationObject}
  */
-export declare type OperationObject = (OpenAPIV3.OperationObject | OpenAPIV3_1.OperationObject) & {
-    [extension: string]: unknown;
-};
+export declare type OperationObject = (OpenAPIV3.OperationObject | OpenAPIV3_1.OperationObject) & Record<string, unknown>;
 /**
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameterObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameterObject}
@@ -121,7 +115,7 @@ export declare type SchemaObject = (OpenAPIV3.SchemaObject | OpenAPIV3_1.SchemaO
     readOnly?: boolean;
     writeOnly?: boolean;
     example?: unknown;
-    examples?: Array<unknown>;
+    examples?: unknown[];
     nullable?: boolean;
     xml?: unknown;
     externalDocs?: unknown;
@@ -139,9 +133,7 @@ export declare function isSchema(check: unknown, isPolymorphicAllOfChild?: boole
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#securitySchemeObject}
  */
 export declare type SecuritySchemeObject = OpenAPIV3.SecuritySchemeObject | OpenAPIV3_1.SecuritySchemeObject;
-export declare type SecuritySchemesObject = {
-    [key: string]: SecuritySchemeObject;
-};
+export declare type SecuritySchemesObject = Record<string, SecuritySchemeObject>;
 export declare type KeyedSecuritySchemeObject = {
     _key: string;
     'x-default'?: string | number;

package/@types/samples/index.d.ts

@@ -19,6 +19,6 @@ import memoize from 'memoizee';
 declare function sampleFromSchema(schema: RMOAS.SchemaObject, opts?: {
     includeReadOnly?: boolean;
     includeWriteOnly?: boolean;
-}): string | number | boolean | null | Array<unknown> | Record<string, unknown> | undefined;
+}): string | number | boolean | null | unknown[] | Record<string, unknown> | undefined;
 declare const _default: typeof sampleFromSchema & memoize.Memoized<typeof sampleFromSchema>;
 export default _default;

package/@types/samples/utils.d.ts

@@ -7,6 +7,6 @@
 import type * as RMOAS from '../rmoas.types';
 export declare function usesPolymorphism(schema: RMOAS.SchemaObject): false | "oneOf" | "anyOf" | "allOf";
 export declare function objectify(thing: unknown | Record<string, unknown>): Record<string, any>;
-export declare function normalizeArray(arr: string | number | Array<string | number>): (string | number)[];
+export declare function normalizeArray(arr: string | number | (string | number)[]): (string | number)[];
 export declare function isFunc(thing: unknown): thing is Function;
 export declare function deeplyStripKey(input: unknown, keyToStrip: string, predicate?: (obj: unknown, key?: string) => boolean): any | RMOAS.SchemaObject;

package/@types/utils.d.ts

@@ -4,10 +4,7 @@ declare const supportedMethods: Set<string>;
 declare const _default: {
     findSchemaDefinition: typeof findSchemaDefinition;
     getSchema: typeof getSchema;
-    jsonSchemaTypes: {
-        [key: string]: string;
-        [key: number]: string;
-    };
+    jsonSchemaTypes: Record<string, string>;
     matchesMimeType: {
         formUrlEncoded: (mimeType: string) => boolean;
         json: (contentType: string) => boolean;

package/CHANGELOG.md

@@ -1,3 +1,38 @@
+## <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)
+* 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)
+
+
+
 ## <small>17.7.2 (2022-02-02)</small>
 
 * chore(deps-dev): bump @commitlint/cli from 16.0.1 to 16.1.0 (#591) ([a46f0ab](https://github.com/readmeio/oas/commit/a46f0ab)), closes [#591](https://github.com/readmeio/oas/issues/591)

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];
@@ -667,8 +671,10 @@ var Oas = /** @class */ (function () {
      * Dereference the current OAS definition so it can be parsed free of worries of `$ref` schemas and circular
      * structures.
      *
+     * @param opts
      */
-    Oas.prototype.dereference = function () {
+    Oas.prototype.dereference = function (opts) {
+        if (opts === void 0) { opts = { preserveRefAsJSONSchemaTitle: false }; }
         return __awaiter(this, void 0, void 0, function () {
             var _a, api, promises;
             var _this = this;
@@ -690,6 +696,12 @@ var Oas = /** @class */ (function () {
                 // dereferencing happens below those names will be preserved.
                 if (api && api.components && api.components.schemas && typeof api.components.schemas === 'object') {
                     Object.keys(api.components.schemas).forEach(function (schemaName) {
+                        if (opts.preserveRefAsJSONSchemaTitle) {
+                            // This may result in some data loss if there's already a `title` present, but in the case
+                            // where we want to generate code for the API definition (see http://npm.im/api), we'd
+                            // prefer to retain original reference name as a title for any generated types.
+                            api.components.schemas[schemaName].title = schemaName;
+                        }
                         api.components.schemas[schemaName]['x-readme-ref-name'] = schemaName;
                     });
                 }

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.2",
+  "version": "17.8.1",
   "description": "Working with OpenAPI definitions is hard. This makes it easier.",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",
@@ -62,12 +62,12 @@
     "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",
     "@commitlint/config-conventional": "^16.0.0",
-    "@readme/eslint-config": "^8.1.2",
+    "@readme/eslint-config": "^8.4.1",
     "@readme/oas-examples": "^4.3.2",
     "@types/jest": "^27.0.2",
     "@types/json-schema-merge-allof": "^0.6.1",