Class JsonSchemaInputProcessor

Class for processing JSON Schema

Hierarchy (view full)

AbstractInputProcessor
- JsonSchemaInputProcessor

Index

Constructors

constructor

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

Properties

`Static` MODELGEN_INFFERED_NAME

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

Methods

dereferenceInputs

dereferenceInputs(input): Promise<any>
Parameters
- input: any
Returns Promise<any>
- Defined in src/processors/JsonSchemaInputProcessor.ts:220

handleRootReference

handleRootReference(input): any
This is a hotfix and really only a partial solution as it does not cover all cases.

But it's the best we can do until we find or build a better library to handle references.
Parameters
- input: any
Returns any
- Defined in src/processors/JsonSchemaInputProcessor.ts:188

process

process(input, options?): Promise<InputMetaModel>
Function for processing a JSON Schema input.
Parameters
- input: any
- Optional options: ProcessorOptions
Returns Promise<InputMetaModel>
Overrides AbstractInputProcessor.process
- Defined in src/processors/JsonSchemaInputProcessor.ts:51

`Private` processDraft4

processDraft4(input, options?): Promise<InputMetaModel>
Process a draft-4 schema
Parameters
- input: any
  to process as draft 4
- Optional options: ProcessorOptions
Returns Promise<InputMetaModel>
- Defined in src/processors/JsonSchemaInputProcessor.ts:128

`Private` processDraft6

processDraft6(input, options?): Promise<InputMetaModel>
Process a draft-6 schema
Parameters
- input: any
  to process as draft-6
- Optional options: ProcessorOptions
Returns Promise<InputMetaModel>
- Defined in src/processors/JsonSchemaInputProcessor.ts:158

`Private` processDraft7

processDraft7(input, options?): Promise<InputMetaModel>
Process a draft-7 schema
Parameters
- input: any
  to process as draft 7
- Optional options: ProcessorOptions
Returns Promise<InputMetaModel>
- Defined in src/processors/JsonSchemaInputProcessor.ts:98

shouldProcess

shouldProcess(input): boolean
Unless the schema states one that is not supported we assume its of type JSON Schema
Parameters
- input: any
Returns boolean
Overrides AbstractInputProcessor.shouldProcess
- Defined in src/processors/JsonSchemaInputProcessor.ts:76

`Static` convertSchemaToCommonModel

convertSchemaToCommonModel(schema, options?): CommonModel
Simplifies a JSON Schema into a common models
Parameters
- schema: boolean | Draft6Schema | Draft4Schema | Draft7Schema | SwaggerV2Schema | OpenapiV3Schema | AsyncapiV2Schema
  to simplify to common model
- Optional options: ProcessorOptions
Returns CommonModel
- Defined in src/processors/JsonSchemaInputProcessor.ts:536

`Static` convertSchemaToMetaModel

convertSchemaToMetaModel(schema, options?): MetaModel
Simplifies a JSON Schema into a common models
Parameters
- schema: boolean | Draft6Schema | Draft4Schema | Draft7Schema | SwaggerV2Schema | OpenapiV3Schema | AsyncapiV2Schema
  to simplify to common model
- Optional options: ProcessorOptions
Returns MetaModel
- Defined in src/processors/JsonSchemaInputProcessor.ts:563

`Static` `Private` ensureNamePattern

ensureNamePattern(previousName, ...newParts): string
Ensure schema name using previous name and new part
Parameters
- previousName: undefined | string
  to concatenate with
- Rest ...newParts: any[]
Returns string
- Defined in src/processors/JsonSchemaInputProcessor.ts:520

`Static` reflectSchemaNames

reflectSchemaNames(schema, namesStack, seenSchemas, name?, isRoot?): any
Each schema must have a name, so when later interpreted, the model have the most accurate model name.

Reflect name from given schema and save it to x-modelgen-inferred-name extension.

This reflects all the common keywords that are shared between draft-4, draft-7 and Swagger 2.0 Schema
Parameters
- schema: boolean | Draft6Schema | Draft4Schema | Draft7Schema | SwaggerV2Schema | OpenapiV3Schema
  to process
- namesStack: Record<string, number>
  is a aggregator of previous used names
- seenSchemas: Set<Draft6Schema | Draft4Schema | Draft7Schema | SwaggerV2Schema | OpenapiV3Schema>
  is a set of schema already seen and named
- Optional name: string
  to infer
- Optional isRoot: boolean
  indicates if performed schema is a root schema
Returns any
- Defined in src/processors/JsonSchemaInputProcessor.ts:271

Class JsonSchemaInputProcessor

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns JsonSchemaInputProcessor

Properties

Static MODELGEN_INFFERED_NAME

Methods

dereferenceInputs

Parameters

Returns Promise<any>

handleRootReference

Parameters

Returns any

process

Parameters

Returns Promise<InputMetaModel>

Private processDraft4

Parameters

Returns Promise<InputMetaModel>

Private processDraft6

Parameters

Returns Promise<InputMetaModel>

Private processDraft7

Parameters

Returns Promise<InputMetaModel>

shouldProcess

Parameters

Returns boolean

Static convertSchemaToCommonModel

Parameters

Returns CommonModel

Static convertSchemaToMetaModel

Parameters

Returns MetaModel

Static Private ensureNamePattern

Parameters

Returns string

Static reflectSchemaNames

Parameters

Returns any

Settings

Member Visibility

Theme

On This Page

`Static` MODELGEN_INFFERED_NAME

`Private` processDraft4

`Private` processDraft6

`Private` processDraft7

`Static` convertSchemaToCommonModel

`Static` convertSchemaToMetaModel

`Static` `Private` ensureNamePattern

`Static` reflectSchemaNames