Class PathParamsBuilder

PathParamsBuilder generates information about path queries for OperationObject

Hierarchy

PathParamsBuilderBase
- PathParamsBuilder

Index

Constructors

Properties

Methods

_genHeader _genTableContent _getParam _getSchemaObj genDef

Constructors

constructor

new PathParamsBuilder(options?): PathParamsBuilder
Parameters
- Optional options: IRavageOptions
Returns PathParamsBuilder
Inherited from PathParamsBuilderBase.constructor
- Defined in pdfParts/pathParamsBuilder.ts:19

Properties

`Protected` `Optional` _options

_options?: IRavageOptions

Methods

`Protected` _genHeader

_genHeader(): Promise<Content>
Genereates header Content block for PathParams

Returns Promise<Content>
Overrides PathParamsBuilderBase._genHeader
- Defined in pdfParts/pathParamsBuilder.ts:84

`Protected` _genTableContent

_genTableContent(operationObj, openapi): Promise<Content>
Generates tableContent by operationObject
Parameters
- operationObj: OperationObjectWithPath
- openapi: OpenapiInfoV3
Returns Promise<Content>
Overrides PathParamsBuilderBase._genTableContent
- Defined in pdfParts/pathParamsBuilder.ts:124

`Protected` _getParam

_getParam(param, opeanapi): Promise<ParameterObject>
Returns query path param
Parameters
- param: ReferenceObject | ParameterObject
- opeanapi: OpenapiInfoV3
Returns Promise<ParameterObject>
Overrides PathParamsBuilderBase._getParam
- Defined in pdfParts/pathParamsBuilder.ts:92

`Protected` _getSchemaObj

_getSchemaObj(obj, openapi): Promise<SchemaObject>
Returns schemaObject from OpenAPIV3.ReferenceObject or from OpenAPIV3.SchemaObject
Parameters
- obj: ReferenceObject | SchemaObject
- openapi: OpenapiInfoV3
Returns Promise<SchemaObject>
Overrides PathParamsBuilderBase._getSchemaObj
- Defined in pdfParts/pathParamsBuilder.ts:104

genDef

genDef(operationObj, openapi): Promise<Content>
Generates Content block for table PathParamsBuilder
Parameters
- operationObj: OperationObjectWithPath
- openapi: OpenapiInfoV3
Returns Promise<Content>
Overrides PathParamsBuilderBase.genDef
- Defined in pdfParts/pathParamsBuilder.ts:221

Generated using TypeDoc