Class PathBuilder

PathBuilder generate Content block for path part of openapi specs and generates header, description, pathParams, request, responses

Hierarchy

PathBuilderBase
- PathBuilder

Index

Constructors

Properties

_description _header _options? _pathParams _pathParamsBuilder _request _requestBuilder _responses _responsesBuilder

Methods

_buildContent _genDescription _genHeader _genPathParams _genRequest _genResponses genPath

Constructors

constructor

new PathBuilder(options?): PathBuilder
Parameters
- Optional options: IRavageOptions
Returns PathBuilder
Inherited from PathBuilderBase.constructor
- Defined in pdfParts/pathBuilder.ts:27

Properties

`Protected` _description

_description: Content

`Protected` _header

_header: Content[]

`Protected` `Optional` _options

_options?: IRavageOptions

`Protected` _pathParams

_pathParams: Content

`Protected` _pathParamsBuilder

_pathParamsBuilder: PathParamsBuilder

`Protected` _request

_request: Content

`Protected` _requestBuilder

_requestBuilder: RequestBuilder

`Protected` _responses

_responses: Content

`Protected` _responsesBuilder

_responsesBuilder: ResponsesBuilder

Methods

`Protected` _buildContent

_buildContent(tagSeq, methodSeq, operationObject, openapi): Promise<void>
Build all content with declared methods
Parameters
- tagSeq: number
- methodSeq: number
- operationObject: OperationObjectWithPath
- openapi: OpenapiInfoV3
Returns Promise<void>
Overrides PathBuilderBase._buildContent
- Defined in pdfParts/pathBuilder.ts:225

`Protected` _genDescription

_genDescription(operationObject): Promise<Content>
Generates description for path OperaitonObject
Parameters
- operationObject: OperationObjectWithPath
Returns Promise<Content>
Overrides PathBuilderBase._genDescription
- Defined in pdfParts/pathBuilder.ts:187

`Protected` _genHeader

_genHeader(tagSeq, methodSeq, operationObject): Promise<Content[]>
Generates header for path OperaitonObject
Parameters
- tagSeq: number
- methodSeq: number
- operationObject: OperationObjectWithPath
Returns Promise<Content[]>
Overrides PathBuilderBase._genHeader
- Defined in pdfParts/pathBuilder.ts:154

`Protected` _genPathParams

_genPathParams(operationObject, openapi): Promise<Content>
Generates PathParams for path OperationObject
Parameters
- operationObject: OperationObjectWithPath
- openapi: OpenapiInfoV3
Returns Promise<Content>
Overrides PathBuilderBase._genPathParams
- Defined in pdfParts/pathBuilder.ts:197

`Protected` _genRequest

_genRequest(operationObject, openapi): Promise<Content>
Generates request description for path Operationobject
Parameters
- operationObject: OperationObjectWithPath
- openapi: OpenapiInfoV3
Returns Promise<Content>
Overrides PathBuilderBase._genRequest
- Defined in pdfParts/pathBuilder.ts:206

`Protected` _genResponses

_genResponses(operationObject, openapi): Promise<Content>
Generates response description for path OperationObject
Parameters
- operationObject: OperationObjectWithPath
- openapi: OpenapiInfoV3
Returns Promise<Content>
Overrides PathBuilderBase._genResponses
- Defined in pdfParts/pathBuilder.ts:216

genPath

genPath(tagSeq, methodSeq, operationObject, openapi): Promise<Content>
Generates path Content block for provided OperaiotnObject
Parameters
- tagSeq: number
- methodSeq: number
- operationObject: OperationObjectWithPath
- openapi: OpenapiInfoV3
Returns Promise<Content>
Overrides PathBuilderBase.genPath
- Defined in pdfParts/pathBuilder.ts:242

Generated using TypeDoc