Class OpenAPIInputProcessor

Class for processing OpenAPI inputs

Hierarchy (view full)

AbstractInputProcessor
- OpenAPIInputProcessor

Index

Constructors

constructor

new OpenAPIInputProcessor(): OpenAPIInputProcessor
Returns OpenAPIInputProcessor
Inherited from AbstractInputProcessor.constructor

Properties

`Static` MODELGEN_INFFERED_NAME

MODELGEN_INFFERED_NAME: string = 'x-modelgen-inferred-name'

`Static` supportedVersions

supportedVersions: string[] = ...

Methods

`Private` includeSchema

includeSchema(schema, name, inputModel, options?): void
Parameters
- schema: SchemaObject | SchemaObject
- name: string
- inputModel: InputMetaModel
- Optional options: ProcessorOptions
Returns void
- Defined in src/processors/OpenAPIInputProcessor.ts:254

`Private` iterateMediaType

iterateMediaType(mediaTypes, path, inputModel, options?): void
Parameters
- mediaTypes: {
  [media: string]: OpenAPIV3.MediaTypeObject | OpenAPIV3_1.MediaTypeObject;
  }
  - [media: string]: OpenAPIV3.MediaTypeObject | OpenAPIV3_1.MediaTypeObject
- path: string
- inputModel: InputMetaModel
- Optional options: ProcessorOptions
Returns void
- Defined in src/processors/OpenAPIInputProcessor.ts:227

`Private` iterateParameters

iterateParameters(parameters, path, inputModel, options?): void
Parameters
- parameters: undefined | (ReferenceObject | ParameterObject)[] | (ParameterObject | ReferenceObject)[]
- path: string
- inputModel: InputMetaModel
- Optional options: ProcessorOptions
Returns void
- Defined in src/processors/OpenAPIInputProcessor.ts:205

`Private` iterateResponses

iterateResponses(responses, path, inputModel, options?): void
Parameters
- responses: ResponsesObject | ResponsesObject
- path: string
- inputModel: InputMetaModel
- Optional options: ProcessorOptions
Returns void
- Defined in src/processors/OpenAPIInputProcessor.ts:186

process

process(input, options?): Promise<InputMetaModel>
Process the input as a OpenAPI document
Parameters
- input: any
- Optional options: ProcessorOptions
Returns Promise<InputMetaModel>
Overrides AbstractInputProcessor.process
- Defined in src/processors/OpenAPIInputProcessor.ts:22

`Private` processOperation

processOperation(operation, path, inputModel, options?): void
Parameters
- operation: undefined | {
      callbacks?: {
          [callback: string]: ReferenceObject | CallbackObject;
      };
      deprecated?: boolean;
      description?: string;
      externalDocs?: ExternalDocumentationObject;
      operationId?: string;
      parameters?: (ReferenceObject | ParameterObject)[];
      requestBody?: ReferenceObject | RequestBodyObject;
      responses: ResponsesObject;
      security?: SecurityRequirementObject[];
      servers?: ServerObject[];
      summary?: string;
      tags?: string[];
  } | OperationObject<{}>
- path: string
- inputModel: InputMetaModel
- Optional options: ProcessorOptions
Returns void
- Defined in src/processors/OpenAPIInputProcessor.ts:133

`Private` processPath

processPath(pathObject, path, inputModel, options?): void
Parameters
- pathObject: undefined | PathItemObject<{}> | PathItemObject<{}>
- path: string
- inputModel: InputMetaModel
- Optional options: ProcessorOptions
Returns void
- Defined in src/processors/OpenAPIInputProcessor.ts:60

shouldProcess

shouldProcess(input): boolean
Figures out if an object is of type OpenAPI V3.0.x document and supported
Parameters
- input: any
Returns boolean
Overrides AbstractInputProcessor.shouldProcess
- Defined in src/processors/OpenAPIInputProcessor.ts:303

tryGetVersionOfDocument

tryGetVersionOfDocument(input): undefined | string
Try to find the AsyncAPI version from the input. If it cannot undefined are returned, if it can, the version is returned.
Parameters
- input: any
Returns undefined | string
- Defined in src/processors/OpenAPIInputProcessor.ts:316

`Static` convertToInternalSchema

convertToInternalSchema(schema, name): OpenapiV3Schema
Converts a schema to the internal schema format.
Parameters
- schema: SchemaObject | SchemaObject
  to convert
- name: string
  of the schema
Returns OpenapiV3Schema
- Defined in src/processors/OpenAPIInputProcessor.ts:283

Class OpenAPIInputProcessor

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns OpenAPIInputProcessor

Properties

Static MODELGEN_INFFERED_NAME

Static supportedVersions

Methods

Private includeSchema

Parameters

Returns void

Private iterateMediaType

Parameters

[media: string]: OpenAPIV3.MediaTypeObject | OpenAPIV3_1.MediaTypeObject

Returns void

Private iterateParameters

Parameters

Returns void

Private iterateResponses

Parameters

Returns void

process

Parameters

Returns Promise<InputMetaModel>

Private processOperation

Parameters

Returns void

Private processPath

Parameters

Returns void

shouldProcess

Parameters

Returns boolean

tryGetVersionOfDocument

Parameters

Returns undefined | string

Static convertToInternalSchema

Parameters

Returns OpenapiV3Schema

Settings

Member Visibility

Theme

On This Page

`Static` MODELGEN_INFFERED_NAME

`Static` supportedVersions

`Private` includeSchema

`Private` iterateMediaType

`Private` iterateParameters

`Private` iterateResponses

`Private` processOperation

`Private` processPath

`Static` convertToInternalSchema