Class ResponseBuilder

ResponseBuilderBase generates request information block with header, description, path params, body schema and examples

Hierarchy

ResponseBuilderBase
- ResponseBuilder

Index

Constructors

Properties

_exampleBuilder _mediaTreeBuilder _options?

Methods

_genHeader _genInfo genResponse

Constructors

constructor

new ResponseBuilder(options?): ResponseBuilder
Parameters
- Optional options: IRavageOptions
Returns ResponseBuilder
Inherited from ResponseBuilderBase.constructor
- Defined in pdfParts/responseBuilder.ts:19

Properties

`Protected` _exampleBuilder

_exampleBuilder: ExampleBuilder

`Protected` _mediaTreeBuilder

_mediaTreeBuilder: MediaTreeBuilder

`Protected` `Optional` _options

_options?: IRavageOptions

Methods

`Protected` _genHeader

_genHeader(code, response): Promise<Content>
Generates header for Reponse
Parameters
- code: string
- response: ResponseObject
Returns Promise<Content>
Overrides ResponseBuilderBase._genHeader
- Defined in pdfParts/responseBuilder.ts:71

`Protected` _genInfo

_genInfo(responseBody, openapi): Promise<Content>
Generates information about response
Parameters
- responseBody: ResponseObject
- openapi: OpenapiInfoV3
Returns Promise<Content>
Overrides ResponseBuilderBase._genInfo
- Defined in pdfParts/responseBuilder.ts:89

genResponse

genResponse(code, response, openapi): Promise<Content>
Generates Response Content block
Parameters
- code: string
- response: ResponseObject
- openapi: OpenapiInfoV3
Returns Promise<Content>
Overrides ResponseBuilderBase.genResponse
- Defined in pdfParts/responseBuilder.ts:118

Generated using TypeDoc