Class ResponsesBuilderBase`Abstract`

ResponsesBuilderBase builds responses Content blocks for PathsTagBuilderBase

Hierarchy

ResponsesBuilderBase
- ResponsesBuilder

Index

Constructors

Properties

_options? _responseBuilder

Methods

_genHeader genDef

Constructors

constructor

new ResponsesBuilderBase(options?): ResponsesBuilderBase
Parameters
- Optional options: IRavageOptions
Returns ResponsesBuilderBase
- Defined in pdfParts/responsesBuilder.ts:16

Properties

`Protected` `Optional` _options

_options?: IRavageOptions

`Protected` _responseBuilder

_responseBuilder: ResponseBuilder

Methods

`Protected` `Abstract` _genHeader

_genHeader(): Promise<Content>
Generates header for responses

Returns Promise<Content>
- Defined in pdfParts/responsesBuilder.ts:28

`Abstract` genDef

genDef(responses, openapi): Promise<Content>
Generates Content block for reponses
Parameters
- responses: ResponsesObject
- openapi: OpenapiInfoV3
Returns Promise<Content>
- Defined in pdfParts/responsesBuilder.ts:36

Generated using TypeDoc