oas 17.4.2 → 17.7.0

package/@types/index.d.ts

@@ -59,15 +59,15 @@ export default class Oas {
      *
      * @param oas An OpenAPI definition.
      * @param user The information about a user that we should use when pulling auth tokens from security schemes.
-     * @returns An instance of the Oas class.
      */
     static init(oas: Record<string, unknown> | RMOAS.OASDocument, user?: RMOAS.User): Oas;
     /**
-     * @returns The OpenAPI version that this API definition is targeted for.
+     * Retrieve the OpenAPI version that this API definition is targeted for.
      */
     getVersion(): string;
     /**
-     * @returns The current OpenAPI API Definition.
+     * Retrieve the current OpenAPI API Definition.
+     *
      */
     getDefinition(): RMOAS.OASDocument;
     url(selected?: number, variables?: Variables): string;
@@ -86,7 +86,7 @@ export default class Oas {
         value: string;
         key: string;
         description: string;
-        enum: string[] | [string, ...string[]];
+        enum: string[];
     })[];
     /**
      * With a fully composed server URL, run through our list of known OAS servers and return back which server URL was
@@ -100,7 +100,6 @@ export default class Oas {
      * Re-supplying this data to `oas.url()` should return the same URL you passed into this method.
      *
      * @param baseUrl A given URL to extract server variables out of.
-     * @returns The extracted server variables and the configured server that they were matched to.
      */
     splitVariables(baseUrl: string): false | {
         selected: number;
@@ -123,7 +122,6 @@ export default class Oas {
      *
      * @param url A URL to swap variables into.
      * @param variables An object containing variables to swap into the URL.
-     * @returns The new URL with the variables.
      */
     replaceUrl(url: string, variables?: Variables): string;
     /**
@@ -133,7 +131,6 @@ export default class Oas {
      * @param method HTTP Method to retrieve on the path.
      * @param opts Options
      * @param opts.isWebhook If you prefer to first look for a webhook with this path and method.
-     * @returns The found Operation or Webhook.
      */
     operation(path: string, method: RMOAS.HttpMethods, opts?: {
         isWebhook?: boolean;
@@ -146,15 +143,13 @@ export default class Oas {
      *
      * @param url A full URL to look up.
      * @param method The cooresponding HTTP method to look up.
-     * @returns An object containing matches that were discovered in the API definition.
      */
     findOperation(url: string, method: RMOAS.HttpMethods): PathMatch;
     /**
-     * Discover an operation in an OAS from a fully-formed URL without an HTTP method. Will return an object containing a `url`
-     * object and another one for `operation`.
+     * Discover an operation in an OAS from a fully-formed URL without an HTTP method. Will return an object containing a
+     * `url` object and another one for `operation`.
      *
      * @param url A full URL to look up.
-     * @returns An object containing matches that were discovered in the API definition.
      */
     findOperationWithoutMethod(url: string): PathMatch;
     /**
@@ -163,16 +158,14 @@ export default class Oas {
      *
      * @param url A full URL to look up.
      * @param method The cooresponding HTTP method to look up.
-     * @returns The found operation or webhook.
      */
     getOperation(url: string, method: RMOAS.HttpMethods): Operation;
     /**
-     * With an object of user information, retrieve an appropriate API key from the current OAS definition.
+     * With an object of user information, retrieve the appropriate API auth keys from the current OAS definition.
      *
      * @see {@link https://docs.readme.com/docs/passing-data-to-jwt}
      * @param user User
      * @param selectedApp The user app to retrieve an auth key for.
-     * @returns Found auth keys for the found security schemes.
      */
     getAuth(user: RMOAS.User, selectedApp?: string | number): {
         [x: string]: unknown;
@@ -183,7 +176,6 @@ export default class Oas {
      *
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#oasObject}
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#openapi-object}
-     * @returns The Paths that exist on this API definition.
      */
     getPaths(): Record<string, Record<RMOAS.HttpMethods, Operation | Webhook>>;
     /**
@@ -192,7 +184,6 @@ export default class Oas {
      *
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#oasObject}
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#openapi-object}
-     * @returns The Webhooks that exist on this API definition.
      */
     getWebhooks(): Record<string, Record<RMOAS.HttpMethods, Webhook>>;
     /**
@@ -202,9 +193,8 @@ export default class Oas {
      *
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#oasObject}
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#openapi-object}
-     * @param {boolean} setIfMissing If a tag is not present on an operation that operations path will be added into the
-     *    list of tags returned.
-     * @returns An array of tags.
+     * @param setIfMissing If a tag is not present on an operation that operations path will be added into the list of
+     *    tags returned.
      */
     getTags(setIfMissing?: boolean): unknown[];
     /**
@@ -213,7 +203,6 @@ export default class Oas {
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specificationExtensions}
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions}
      * @param extension Specification extension to lookup.
-     * @returns The extension exists.
      */
     hasExtension(extension: string): boolean;
     /**
@@ -222,14 +211,12 @@ export default class Oas {
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specificationExtensions}
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions}
      * @param extension Specification extension to lookup.
-     * @returns The extension contents if it was found.
      */
     getExtension(extension: string): unknown;
     /**
      * Dereference the current OAS definition so it can be parsed free of worries of `$ref` schemas and circular
      * structures.
      *
-     * @returns A post-dereference Promise.
      */
     dereference(): Promise<unknown>;
 }

package/@types/lib/dedupe-common-parameters.d.ts

@@ -0,0 +1,9 @@
+import * as RMOAS from '../rmoas.types';
+/**
+ * With an array of common parameters filter down them to what isn't already present in a list of non-common
+ * parameters.
+ *
+ * @param parameters
+ * @param commonParameters
+ */
+export default function dedupeCommonParameters(parameters: RMOAS.ParameterObject[], commonParameters: RMOAS.ParameterObject[]): import("openapi-types").OpenAPIV3.ParameterObject[];

package/@types/lib/find-schema-definition.d.ts

@@ -1,6 +1,7 @@
 /**
+ * Lookup a reference pointer within an OpenAPI definition and return the schema that it resolves to.
+ *
  * @param $ref Reference to look up a schema for.
  * @param definitions OpenAPI definition to look for the `$ref` pointer in.
- * @returns Found schema.
  */
 export default function findSchemaDefinition($ref: string, definitions?: {}): any;

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

@@ -15,17 +15,14 @@ declare type authKey = null | unknown | {
  * @param user User
  * @param scheme Security scheme to get auth keys for.
  * @param selectedApp The user app to retrieve an auth key for.
- * @returns The found auth key for this security scheme.
  */
-export declare function getByScheme(user: RMOAS.User, scheme?: RMOAS.KeyedSecuritySchemeObject, // eslint-disable-line default-param-last
-selectedApp?: string | number): authKey;
+export declare function getByScheme(user: RMOAS.User, scheme?: RMOAS.KeyedSecuritySchemeObject, selectedApp?: string | number): authKey;
 /**
  * Retrieve auth keys for an API definition from a given user for a specific "app" that they have configured.
  *
  * @param api API definition
  * @param user User
  * @param selectedApp The user app to retrieve an auth key for.
- * @returns Found auth keys for the found security schemes.
  */
 export default function getAuth(api: OpenAPIV3.Document | OpenAPIV3_1.Document, user: RMOAS.User, selectedApp?: string | number): {
     [x: string]: unknown;

package/@types/lib/get-mediatype-examples.d.ts

@@ -6,7 +6,7 @@ export declare type MediaTypeExample = {
     value: unknown;
 };
 /**
- * Extracts an array of examples from an OpenAPI Media Type Object. The example will either come from the `example`
+ * Extracts a collection of examples from an OpenAPI Media Type Object. The example will either come from the `example`
  * property, the first item in an `examples` array, or if none of those are present it will generate an example based
  * off its schema.
  *
@@ -17,6 +17,5 @@ export declare type MediaTypeExample = {
  * @param opts Options
  * @param opts.includeReadOnly If you wish to include data that's flagged as `readOnly`.
  * @param opts.includeWriteOnly If you wish to include data that's flatted as `writeOnly`.
- * @returns Array of media type examples.
  */
 export default function getMediaTypeExamples(mediaType: string, mediaTypeObject: RMOAS.MediaTypeObject, opts?: {}): MediaTypeExample[];

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

@@ -1,15 +1,15 @@
 import type * as RMOAS from '../rmoas.types';
 /**
- * Gets the schema of the first media type defined in the `content` of the path operation or returns the ref if there's
- * no Request Body Object.
+ * Retrieves the schema of the first media type defined in the `content` of the path operation or returns the reference
+ * if there's no Request Body Object.
  *
- * If the ref looks like a `requestBodies` reference, then do a lookup for the actual schema.
+ * If the reference pointer looks like a `requestBodies` reference, then we also do a lookup for the actual schema.
  *
+ * @deprecated
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#fixed-fields-8}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#fixed-fields-8}
  * @param operation Operation to look for a primary requestBody schema in.
  * @param api The API definition that this operation exists within.
- * @returns The found requestBody schema.
  */
 export default function getSchema(operation: RMOAS.OperationObject, api?: RMOAS.OASDocument | {
     [schemaType: string]: {

package/@types/lib/get-user-variable.d.ts

@@ -6,6 +6,5 @@ import type * as RMOAS from '../rmoas.types';
  * @param user The user to get a user variable for.
  * @param property The name of the variable to retrieve.
  * @param selectedApp The user app to retrieve an auth key for.
- * @returns Found user variable.
  */
 export default function getUserVariable(user: RMOAS.User, property: string, selectedApp?: string | number): unknown;

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

@@ -9,9 +9,6 @@ export declare type toJsonSchemaOptions = {
     prevSchemas?: PrevSchemasType;
     refLogger?: (ref: string) => void;
 };
-/**
- * @param val
- */
 export declare function isPrimitive(val: unknown): boolean;
 /**
  * Given an OpenAPI-flavored JSON Schema, make an effort to modify it so it's shaped more towards stock JSON Schema.
@@ -24,31 +21,31 @@ export declare function isPrimitive(val: unknown): boolean;
  *    legacy schemas in ReadMe that were ingested before we had proper validation in place, and as a result have some
  *    API definitions that will not pass validation right now. In addition to reshaping OAS-JSON Schema into JSON Schema
  *    this library will also fix these improper schemas: things like `type: object` having `items` instead of
- *    `properties`, `type: array` missing `items`, or `type` missing completely on a schema.
- *  3. Additionally due to OpenAPI 3.0.x not supporting JSON Schema, in order to support the `example` keyword that OAS
+ *    `properties`, or `type: array` missing `items`.
+ *  3. To ease the burden of polymorphic handling on our form rendering engine we make an attempt to merge `allOf`
+ *    schemas here.
+ *  4. Additionally due to OpenAPI 3.0.x not supporting JSON Schema, in order to support the `example` keyword that OAS
  *    supports, we need to do some work in here to remap it into `examples`. However, since all we care about in respect
  *    to examples for usage within `@readme/oas-form`, we're only retaining primitives. This *slightly* deviates from
  *    JSON Schema in that JSON Schema allows for any schema to be an example, but since `@readme/oas-form` can only
  *    actually **render** primitives, that's what we're retaining.
- *  4. Though OpenAPI 3.1 does support full JSON Schema, this library should be able to handle it without any problems.
+ *  5. Though OpenAPI 3.1 does support full JSON Schema, this library should be able to handle it without any problems.
  *
  * And why use this over `@openapi-contrib/openapi-schema-to-json-schema`? Fortunately and unfortunately we've got a lot
  * of API definitions in our database that aren't currently valid so we need to have a lot of bespoke handling for odd
- * quirks, typos, and missing declarations that they've got.
+ * quirks, typos, and missing declarations that might be present.
  *
- * @see {@link https://json-schema.org/draft/2019-09/json-schema-validation.html{}
- * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md}
- * @param {Object} data
- * @param {Object} opts
- * @param {string} opts.currentLocation - Current location within the schema -- this is a JSON pointer.
- * @param {Object} opts.globalDefaults - Object containing a global set of defaults that we should apply to schemas that match it.
- * @param {boolean} opts.isPolymorphicAllOfChild - Is this schema the child of a polymorphic `allOf` schema?
- * @param {Object[]} opts.prevSchemas - Array of parent schemas to utilize when attempting to path together examples.
- * @param {Function} opts.refLogger - A function that's called anytime a (circular) `$ref` is found.
- */
-/**
- * @param data
- * @param opts
+ * @todo add support for `schema: false` and `not` cases.
+ * @see {@link https://json-schema.org/draft/2019-09/json-schema-validation.html}
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schemaObject}
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schemaObject}
+ * @param data OpenAPI Schema Object to convert to pure JSON Schema.
+ * @param opts Options
+ * @param opts.currentLocation Current location within the schema -- this is a JSON pointer.
+ * @param opts.globalDefaults Object containing a global set of defaults that we should apply to schemas that match it.
+ * @param opts.isPolymorphicAllOfChild Is this schema the child of a polymorphic `allOf` schema?
+ * @param opts.prevSchemas Array of parent schemas to utilize when attempting to path together examples.
+ * @param opts.refLogger A function that's called anytime a (circular) `$ref` is found.
  */
-export default function toJSONSchema(data: RMOAS.SchemaObject | RMOAS.RequestBodyObject, opts?: toJsonSchemaOptions): RMOAS.SchemaObject;
+export default function toJSONSchema(data: RMOAS.SchemaObject | boolean, opts?: toJsonSchemaOptions): RMOAS.SchemaObject;
 export {};

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

@@ -6,10 +6,9 @@ export declare type CallbackExamples = Array<{
     example: unknown;
 }>;
 /**
- * With an OpenAPI Operation Object return back an array of examples for any callbacks that may be present.
+ * With an OpenAPI Operation Object return back a collection of examples for any callbacks that may be present.
  *
  * @param operation Operation to retrieve callback examples from.
- * @returns An an array of callback examples.
  */
 export default function getCallbackExamples(operation: RMOAS.OperationObject): {
     identifier: string;

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

@@ -1,4 +1,5 @@
-import type { OASDocument, OperationObject, SchemaObject } from '../rmoas.types';
+import type { OASDocument, SchemaObject } from '../rmoas.types';
+import type Operation from '../operation';
 import * as RMOAS from '../rmoas.types';
 export declare type SchemaWrapper = {
     $schema?: string;
@@ -7,15 +8,18 @@ export declare type SchemaWrapper = {
     schema: SchemaObject;
     deprecatedProps?: SchemaWrapper;
 };
+/**
+ * The order of this object determines how they will be sorted in the compiled JSON Schema representation.
+ *
+ * @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;
 };
-declare const _default: (path: string, operation: OperationObject, api: OASDocument, globalDefaults?: {}) => SchemaWrapper[];
 /**
- * @param {string} path
- * @param {Operation} operation
- * @param {OpenAPI.Document} api
- * @param {Object} globalDefaults
- * @returns {Array<object>}
+ * @param operation
+ * @param api
+ * @param globalDefaults
  */
-export default _default;
+export default function getParametersAsJsonSchema(operation: Operation, api: OASDocument, globalDefaults?: {}): SchemaWrapper[];

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

@@ -4,7 +4,8 @@ export declare type RequestBodyExamples = Array<{
     examples: any;
 }>;
 /**
+ * Retrieve a collection of request body examples, keyed by their media type.
+ *
  * @param operation Operation to retrieve requestBody examples for.
- * @returns An object of response examples keyed by their media type.
  */
 export default function getRequestBodyExamples(operation: RMOAS.OperationObject): RequestBodyExamples;

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

@@ -8,7 +8,6 @@ import type Operation from 'operation';
  * @param operation Operation to construct a response JSON Schema for.
  * @param api The OpenAPI definition that this operation originates.
  * @param statusCode The response status code to generate a schema for.
- * @returns Array<{schema: Object, type: string, label: string}>
  */
 export default function getResponseAsJsonSchema(operation: Operation, api: OASDocument, statusCode: string | number): {
     type: string | Array<string>;

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

@@ -4,7 +4,8 @@ export declare type ResponseExamples = Array<{
     mediaTypes: Record<string, RMOAS.MediaTypeObject>;
 }>;
 /**
+ * Retrieve a collection of response examples keyed, by their media type.
+ *
  * @param operation Operation to retrieve response examples for.
- * @returns An object of response examples keyed by their media type.
  */
 export default function getResponseExamples(operation: RMOAS.OperationObject): ResponseExamples;

package/@types/operation.d.ts

@@ -55,74 +55,73 @@ export default class Operation {
      * Returns an array of all security requirements associated wtih this operation. If none are defined at the operation
      * level, the securities for the entire API definition are returned (with an empty array as a final fallback).
      *
-     * @returns {Array}
      */
     getSecurity(): Array<RMOAS.SecurityRequirementObject>;
     /**
+     * Retrieve a collection of grouped security schemes. The inner array determines and-grouped security schemes, the
+     * outer array determines or-groups.
+     *
      * @see {@link https://swagger.io/docs/specification/authentication/#multiple}
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object}
-     * @param {boolean} filterInvalid Optional flag that, when set to `true`, filters out invalid/nonexistent security
-     *    schemes, rather than returning `false`.
-     * @returns {Array} An array of arrays of objects of grouped security schemes. The inner array determines and-grouped
-     *    security schemes, the outer array determines or-groups.
+     * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#securityRequirementObject}
+     * @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 | {
         security: RMOAS.KeyedSecuritySchemeObject;
         type: SecurityType;
     }>>;
     /**
-     * @returns An object where the keys are unique scheme types, and the values are arrays containing each security
-     *    scheme of that type.
+     * 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>>;
     getHeaders(): Operation['headers'];
     /**
      * Determine if the operation has an operation present in its schema.
      *
-     * @returns {boolean}
      */
     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.
      *
-     * @returns {string}
      */
     getOperationId(): string;
     /**
      * Return an array of all tags, and their metadata, that exist on this operation.
      *
-     * @returns {Array}
      */
     getTags(): Array<RMOAS.TagObject>;
     /**
      * Return is the operation is flagged as `deprecated` or not.
      *
-     * @returns {boolean}
      */
     isDeprecated(): boolean;
+    /**
+     * Determine if the operation has any (non-request body) parameters.
+     *
+     */
+    hasParameters(): boolean;
     /**
      * Return the parameters (non-request body) on the operation.
      *
-     * @todo This should also pull in common params.
-     * @returns {Array}
      */
     getParameters(): Array<RMOAS.ParameterObject>;
     /**
-     * Convert the operation into an array of JSON Schema for each available type of parameter available on the operation.
-     * `globalDefaults` contains an object of user defined parameter defaults used in `constructSchema`.
+     * Convert the operation into an array of JSON Schema schemas for each available type of parameter available on the
+     * operation.
      *
-     * @param {Object} globalDefaults
-     * @returns {Array}
+     * @param globalDefaults Contains an object of user defined schema defaults.
      */
-    getParametersAsJsonSchema(globalDefaults?: unknown): import("./operation/get-parameters-as-json-schema").SchemaWrapper[];
+    getParametersAsJsonSchema(globalDefaults?: Record<string, unknown>): import("./operation/get-parameters-as-json-schema").SchemaWrapper[];
     /**
      * Get a single response for this status code, formatted as JSON schema.
      *
-     * @param {string|number} statusCode
-     * @returns {Array}
+     * @param statusCode
      */
-    getResponseAsJsonSchema(statusCode: string): {
+    getResponseAsJsonSchema(statusCode: string | number): {
         type: string | string[];
         schema: RMOAS.SchemaObject;
         label: string;
@@ -131,38 +130,51 @@ export default class Operation {
     /**
      * Get an array of all valid response status codes for this operation.
      *
-     * @returns {Array}
      */
     getResponseStatusCodes(): Array<string>;
     /**
-     * Determine if the operation has a request body.
+     * Determine if the operation has any request bodies.
      *
-     * @returns {boolean}
      */
     hasRequestBody(): boolean;
+    /**
+     * Retrieve the list of all available media types that the operations request body can accept.
+     *
+     * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#mediaTypeObject}
+     * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#mediaTypeObject}
+     */
+    getRequestBodyMediaTypes(): string[];
+    /**
+     * Retrieve a specific request body content schema off this operation.
+     *
+     * If no media type is supplied this will return either the first available JSON-like request body, or the first
+     * available if there are no JSON-like media types present. When this return comes back it's in the form of an array
+     * with the first key being the selected media type, followed by the media type object in question.
+     *
+     * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#mediaTypeObject}
+     * @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];
     /**
      * Retrieve an array of request body examples that this operation has.
      *
-     * @returns {Array}
      */
     getRequestBodyExamples(): RequestBodyExamples;
     /**
      * Return a specific response out of the operation by a given HTTP status code.
      *
-     * @param {(string|number)} statusCode
-     * @returns {(boolean|object)}
+     * @param statusCode
      */
     getResponseByStatusCode(statusCode: string | number): boolean | RMOAS.ResponseObject;
     /**
      * Retrieve an array of response examples that this operation has.
      *
-     * @returns {Array}
      */
     getResponseExamples(): ResponseExamples;
     /**
      * Determine if the operation has callbacks.
      *
-     * @returns {boolean}
      */
     hasCallbacks(): boolean;
     /**
@@ -173,19 +185,16 @@ export default class Operation {
      * @param identifier Callback identifier to look for.
      * @param expression Callback expression to look for.
      * @param method HTTP Method on the callback to look for.
-     * @returns {(false|Callback)}
      */
     getCallback(identifier: string, expression: string, method: RMOAS.HttpMethods): false | Callback;
     /**
      * Retrieve an array of operations created from each callback.
      *
-     * @returns {Array}
      */
     getCallbacks(): false | Array<false | Callback>;
     /**
      * Retrieve an array of callback examples that this operation has.
      *
-     * @returns {Array}
      */
     getCallbackExamples(): CallbackExamples;
     /**
@@ -194,7 +203,6 @@ export default class Operation {
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specificationExtensions}
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions}
      * @param extension Specification extension to lookup.
-     * @returns The extension exists.
      */
     hasExtension(extension: string): boolean;
     /**
@@ -203,7 +211,6 @@ export default class Operation {
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specificationExtensions}
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions}
      * @param extension Specification extension to lookup.
-     * @returns The extension contents if it was found.
      */
     getExtension(extension: string): unknown;
 }
@@ -222,11 +229,11 @@ export declare class Callback extends Operation {
      *
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#callback-object}
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#callbackObject}
-     * @returns {string}
      */
     getIdentifier(): string;
     getSummary(): string;
     getDescription(): string;
+    getParameters(): Array<RMOAS.ParameterObject>;
 }
 export declare class Webhook extends Operation {
 }

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

@@ -1,5 +1,6 @@
 import type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
 import type { JSONSchema4, JSONSchema6, JSONSchema7 } from 'json-schema';
+export declare type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
 /**
  * @param check Data to determine if it contains a ReferenceObject (`$ref` pointer`).
  * @returns If the supplied data has a `$ref` pointer.
@@ -40,6 +41,15 @@ export declare type ServerVariableObject = OpenAPIV3.ServerVariableObject | Open
 export declare type ServerVariablesObject = {
     [variable: string]: ServerVariableObject;
 };
+export declare type ServerVariable = Record<string, string | number | Array<{
+    default?: string | number;
+}> | {
+    default?: string | number;
+} | Record<string, never>>;
+export declare type Servers = {
+    selected: number;
+    variables: ServerVariable;
+};
 /**
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#componentsObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#componentsObject}
@@ -106,17 +116,17 @@ export declare type HeaderObject = OpenAPIV3.HeaderObject | OpenAPIV3_1.HeaderOb
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schemaObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schemaObject}
  */
-export declare type SchemaObject = (OpenAPIV3.SchemaObject | OpenAPIV3_1.SchemaObject | (JSONSchema4 | JSONSchema6 | JSONSchema7)) & {
+export declare type SchemaObject = (OpenAPIV3.SchemaObject | OpenAPIV3_1.SchemaObject | JSONSchema) & {
     deprecated?: boolean;
     readOnly?: boolean;
     writeOnly?: boolean;
-    'x-readme-ref-name'?: string;
     example?: unknown;
     examples?: Array<unknown>;
     nullable?: boolean;
     xml?: unknown;
     externalDocs?: unknown;
     components?: OpenAPIV3_1.ComponentsObject;
+    'x-readme-ref-name'?: string;
 };
 /**
  * @param check JSON Schema object to determine if it's a non-polymorphic schema.

package/CHANGELOG.md

@@ -1,3 +1,33 @@
+## 17.7.0 (2022-01-27)
+
+* fix: show response headers w/o mediaType content (#584) ([a9bccd1](https://github.com/readmeio/oas/commit/a9bccd1)), closes [#584](https://github.com/readmeio/oas/issues/584)
+
+
+
+## 17.6.0 (2022-01-26)
+
+* chore: add server variable typescript types (#586) ([0868626](https://github.com/readmeio/oas/commit/0868626)), closes [#586](https://github.com/readmeio/oas/issues/586)
+* chore(deps): bumping node-fetch ([0f7dbe1](https://github.com/readmeio/oas/commit/0f7dbe1))
+* fix: funky typing with how we extract examples during JSON Schema generation (#585) ([15ece60](https://github.com/readmeio/oas/commit/15ece60)), closes [#585](https://github.com/readmeio/oas/issues/585)
+* refactor: cleaning up the messy `getSchema` library and other improvements (#581) ([f3f0e43](https://github.com/readmeio/oas/commit/f3f0e43)), closes [#581](https://github.com/readmeio/oas/issues/581)
+* refactor: use default for samples over generic type (#582) ([c1b1c66](https://github.com/readmeio/oas/commit/c1b1c66)), closes [#582](https://github.com/readmeio/oas/issues/582)
+
+
+
+## 17.5.0 (2022-01-12)
+
+* feat: addition of a getRequestBody accessor (#580) ([88b0b33](https://github.com/readmeio/oas/commit/88b0b33)), closes [#580](https://github.com/readmeio/oas/issues/580)
+* fix: refactoring allOf schemas to be pre-merged when we generate JSON Schema (#579) ([cc16e05](https://github.com/readmeio/oas/commit/cc16e05)), closes [#579](https://github.com/readmeio/oas/issues/579)
+* chore: make our jsdoc eslint rules a bit less obnoxious (#577) ([a6bac91](https://github.com/readmeio/oas/commit/a6bac91)), closes [#577](https://github.com/readmeio/oas/issues/577)
+
+
+
+## <small>17.4.3 (2022-01-05)</small>
+
+* fix(operation): support operations without responses (#576) ([67ec319](https://github.com/readmeio/oas/commit/67ec319)), closes [#576](https://github.com/readmeio/oas/issues/576)
+
+
+
 ## <small>17.4.2 (2022-01-05)</small>
 
 * fix: callbacks not having path-level data to retrieve common summaries (#575) ([c7d1144](https://github.com/readmeio/oas/commit/c7d1144)), closes [#575](https://github.com/readmeio/oas/issues/575)