Class RequestBuilder

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

Hierarchy

RequestBuilderBase
- RequestBuilder

Index

Constructors

Properties

_exampleBuilder _mediaTreeBuilder _options?

Methods

_genHeader _genInfo genDef

Constructors

constructor

new RequestBuilder(options?): RequestBuilder
Parameters
- Optional options: IRavageOptions
Returns RequestBuilder
Inherited from RequestBuilderBase.constructor
- Defined in pdfParts/requestBuilder.ts:18

Properties

`Protected` _exampleBuilder

_exampleBuilder: ExampleBuilder

`Protected` _mediaTreeBuilder

_mediaTreeBuilder: MediaTreeBuilder

`Protected` `Optional` _options

_options?: IRavageOptions

Methods

`Protected` _genHeader

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

Returns Promise<Content>
Overrides RequestBuilderBase._genHeader
- Defined in pdfParts/requestBuilder.ts:66

`Protected` _genInfo

_genInfo(requestBody, openapi): Promise<Content>
Generates information about request
Parameters
- requestBody: RequestBodyObject
- openapi: OpenapiInfoV3
Returns Promise<Content>
Overrides RequestBuilderBase._genInfo
- Defined in pdfParts/requestBuilder.ts:74

genDef

genDef(requestBody, openapi): Promise<Content>
Generates Request Content block
Parameters
- requestBody: RequestBodyObject
- openapi: OpenapiInfoV3
Returns Promise<Content>
Overrides RequestBuilderBase.genDef
- Defined in pdfParts/requestBuilder.ts:103

Generated using TypeDoc