Class ResponseBuilder

Hierarchy

ResponseBuilder

Index

Constructors

`Private` constructor

new ResponseBuilder(description: string): ResponseBuilder
Parameters
- description: string
Returns ResponseBuilder
- Defined in src/openapi-builder/responseBuilder.ts:34

Properties

`Private` `Optional` _mimeType

_mimeType?: string

`Private` `Readonly` _response

_response: ResponseObject

`Static` `Private` `Optional` _defaults

_defaults?: ResponseDefaults

Methods

b

b(): ResponseObject
Shorthand for build() method

Returns
A deep copy of the built response object

Returns ResponseObject
- Defined in src/openapi-builder/responseBuilder.ts:54

build

build(): ResponseObject
Creates a deep copy of the current state of the response and returns it.

Returns
A deep copy of the built response object

Returns ResponseObject
- Defined in src/openapi-builder/responseBuilder.ts:45

content

content(content: { [media: string]: OpenAPIV3.MediaTypeObject }): ResponseBuilder
Add a content field to the Response object

Returns
ResponseBuilder instances for method chaining
Parameters
- content: { [media: string]: OpenAPIV3.MediaTypeObject }
  
  The content object per OpenApiv3 spec
  - [media: string]: OpenAPIV3.MediaTypeObject
Returns ResponseBuilder
- Defined in src/openapi-builder/responseBuilder.ts:76

headers

headers(headers: { [header: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.HeaderObject }): ResponseBuilder
Add a header field to the Response object

Returns
ResponseBuilder instances for method chaining
Parameters
- headers: { [header: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.HeaderObject }
  
  The header object per OpenApiv3 spec
  - [header: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.HeaderObject
Returns ResponseBuilder
- Defined in src/openapi-builder/responseBuilder.ts:63

links

links(links: { [link: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.LinkObject }): ResponseBuilder
Add a links field to the Response object

Returns
ResponseBuilder instances for method chaining
Parameters
- links: { [link: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.LinkObject }
  
  The links object per OpenApiv3 spec
  - [link: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.LinkObject
Returns ResponseBuilder
- Defined in src/openapi-builder/responseBuilder.ts:126

schema

schema(schema: ReferenceObject | SchemaObject, mimeType?: string): ResponseBuilder
Add the schema object to the response object. Allows for defining the type of media in place, or inheriting a global default.

Returns
ResponseBuilder instances for method chaining

Throws
A error if there is no default MIME and a mimeType wasn't included locally
Parameters
- schema: ReferenceObject | SchemaObject
  
  The MediaType object per OpenApiv3 spec
- Optional mimeType: string
  
  The string of a valid MIME type
Returns ResponseBuilder
- Defined in src/openapi-builder/responseBuilder.ts:89

schemaArray

schemaArray(schema: ReferenceObject | SchemaObject, mimeType?: string): ResponseBuilder
Add the schema object to the response object as an array. Allows for defining the type of media in place, or inheriting a global default.

Returns
ResponseBuilder instances for method chaining

Throws
A error if there is no default MIME and a mimeType wasn't included locally
Parameters
- schema: ReferenceObject | SchemaObject
  
  The MediaType object per OpenApiv3 spec
- Optional mimeType: string
  
  The string of a valid MIME type
Returns ResponseBuilder
- Defined in src/openapi-builder/responseBuilder.ts:112

`Static` defaults

defaults(defaults: ResponseDefaults): void
Sets defaults for the response object when using the build interface
Parameters
- defaults: ResponseDefaults
  
  The defaults to set - these are global to the ResponseBuilder class
Returns void
- Defined in src/openapi-builder/responseBuilder.ts:20

`Static` new

new(description: string): ResponseBuilder
Start building a new Response object

Returns
ResponseBuilder instances for method chaining
Parameters
- description: string
  
  The description of the response object - only OpenApiv3 required field
Returns ResponseBuilder
- Defined in src/openapi-builder/responseBuilder.ts:29

Class ResponseBuilder

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

description: string

Returns ResponseBuilder

Properties

Private Optional _mimeType

Private Readonly _response

Static Private Optional _defaults

Methods

b

Returns

Returns ResponseObject

build

Returns

Returns ResponseObject

content

Returns

Parameters

content: { [media: string]: OpenAPIV3.MediaTypeObject }

[media: string]: OpenAPIV3.MediaTypeObject

Returns ResponseBuilder

headers

Returns

Parameters

headers: { [header: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.HeaderObject }

[header: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.HeaderObject

Returns ResponseBuilder

links

Returns

Parameters

links: { [link: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.LinkObject }

[link: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.LinkObject

Returns ResponseBuilder

schema

Returns

Throws

Parameters

schema: ReferenceObject | SchemaObject

Optional mimeType: string

Returns ResponseBuilder

schemaArray

Returns

Throws

Parameters

schema: ReferenceObject | SchemaObject

Optional mimeType: string

Returns ResponseBuilder

Static defaults

Parameters

defaults: ResponseDefaults

Returns void

Static new

Returns

Parameters

description: string

Returns ResponseBuilder

Settings

Member Visibility

Theme

`Private` constructor

`Private` `Optional` _mimeType

`Private` `Readonly` _response

`Static` `Private` `Optional` _defaults

`Optional` mimeType: string

`Optional` mimeType: string

`Static` defaults

`Static` new