Class OperationBuilder

Hierarchy

OperationBuilder

Index

Constructors

Properties

Methods

b build callbacks deprecated description externalDocs operationId parameters requestBody security servers summary tags defaults new

Constructors

`Private` constructor

new OperationBuilder(responses: ResponsesObject): OperationBuilder
Parameters
- responses: ResponsesObject
Returns OperationBuilder
- Defined in src/openapi-builder/operationBuilder.ts:38

Properties

`Private` `Readonly` _operation

_operation: { callbacks?: { [callback: string]: ReferenceObject | CallbackObject }; deprecated?: boolean; description?: string; externalDocs?: ExternalDocumentationObject; operationId?: string; parameters?: (ReferenceObject | ParameterObject)[]; requestBody?: ReferenceObject | RequestBodyObject; responses: ResponsesObject; security?: SecurityRequirementObject[]; servers?: ServerObject[]; summary?: string; tags?: string[] }

Type declaration

Optional callbacks?: { [callback: string]: ReferenceObject | CallbackObject }
- [callback: string]: ReferenceObject | CallbackObject
Optional deprecated?: boolean
Optional description?: string
Optional externalDocs?: ExternalDocumentationObject
Optional operationId?: string
Optional parameters?: (ReferenceObject | ParameterObject)[]
Optional requestBody?: ReferenceObject | RequestBodyObject
responses: ResponsesObject
Optional security?: SecurityRequirementObject[]
Optional servers?: ServerObject[]
Optional summary?: string
Optional tags?: string[]

`Static` `Private` `Optional` _defaults

_defaults?: OperationDefaults

Methods

b

b(): { callbacks?: { [callback: string]: ReferenceObject | CallbackObject }; deprecated?: boolean; description?: string; externalDocs?: ExternalDocumentationObject; operationId?: string; parameters?: (ReferenceObject | ParameterObject)[]; requestBody?: ReferenceObject | RequestBodyObject; responses: ResponsesObject; security?: SecurityRequirementObject[]; servers?: ServerObject[]; summary?: string; tags?: string[] }
Shorthand for build() method

Returns
A deep copy of the built operation object

Returns { callbacks?: { [callback: string]: ReferenceObject | CallbackObject }; deprecated?: boolean; description?: string; externalDocs?: ExternalDocumentationObject; operationId?: string; parameters?: (ReferenceObject | ParameterObject)[]; requestBody?: ReferenceObject | RequestBodyObject; responses: ResponsesObject; security?: SecurityRequirementObject[]; servers?: ServerObject[]; summary?: string; tags?: string[] }
- Optional callbacks?: { [callback: string]: ReferenceObject | CallbackObject }
  - [callback: string]: ReferenceObject | CallbackObject
- Optional deprecated?: boolean
- Optional description?: string
- Optional externalDocs?: ExternalDocumentationObject
- Optional operationId?: string
- Optional parameters?: (ReferenceObject | ParameterObject)[]
- Optional requestBody?: ReferenceObject | RequestBodyObject
- responses: ResponsesObject
- Optional security?: SecurityRequirementObject[]
- Optional servers?: ServerObject[]
- Optional summary?: string
- Optional tags?: string[]
- Defined in src/openapi-builder/operationBuilder.ts:56

build

build(): { callbacks?: { [callback: string]: ReferenceObject | CallbackObject }; deprecated?: boolean; description?: string; externalDocs?: ExternalDocumentationObject; operationId?: string; parameters?: (ReferenceObject | ParameterObject)[]; requestBody?: ReferenceObject | RequestBodyObject; responses: ResponsesObject; security?: SecurityRequirementObject[]; servers?: ServerObject[]; summary?: string; tags?: string[] }
Creates a deep copy of the current state of the operation and returns it.

Returns
A deep copy of the built operation object

Returns { callbacks?: { [callback: string]: ReferenceObject | CallbackObject }; deprecated?: boolean; description?: string; externalDocs?: ExternalDocumentationObject; operationId?: string; parameters?: (ReferenceObject | ParameterObject)[]; requestBody?: ReferenceObject | RequestBodyObject; responses: ResponsesObject; security?: SecurityRequirementObject[]; servers?: ServerObject[]; summary?: string; tags?: string[] }
- Optional callbacks?: { [callback: string]: ReferenceObject | CallbackObject }
  - [callback: string]: ReferenceObject | CallbackObject
- Optional deprecated?: boolean
- Optional description?: string
- Optional externalDocs?: ExternalDocumentationObject
- Optional operationId?: string
- Optional parameters?: (ReferenceObject | ParameterObject)[]
- Optional requestBody?: ReferenceObject | RequestBodyObject
- responses: ResponsesObject
- Optional security?: SecurityRequirementObject[]
- Optional servers?: ServerObject[]
- Optional summary?: string
- Optional tags?: string[]
- Defined in src/openapi-builder/operationBuilder.ts:47

callbacks

callbacks(callbacks: { [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject }): OperationBuilder
Add a callbacks field to the Operation object.

Returns
OperationBuilder instances for method chaining
Parameters
- callbacks: { [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject }
  
  The callbacks object per OpenApiv3 spec
  - [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject
Returns OperationBuilder
- Defined in src/openapi-builder/operationBuilder.ts:152

deprecated

deprecated(deprecated: boolean): OperationBuilder
Add a deprecated field to the Operation object.

Returns
OperationBuilder instances for method chaining
Parameters
- deprecated: boolean
  
  The deprecated boolean per OpenApiv3 spec
Returns OperationBuilder
- Defined in src/openapi-builder/operationBuilder.ts:165

description

description(description: string): OperationBuilder
Add a description field to the Operation object

Returns
OperationBuilder instances for method chaining
Parameters
- description: string
  
  The description string per OpenApiv3 spec
Returns OperationBuilder
- Defined in src/openapi-builder/operationBuilder.ts:88

externalDocs

externalDocs(externalDocObject: ExternalDocumentationObject): OperationBuilder
Add a externalDocObject field to the Operation object

Returns
OperationBuilder instances for method chaining
Parameters
- externalDocObject: ExternalDocumentationObject
  
  The externalDocObject object per OpenApiv3 spec
Returns OperationBuilder
- Defined in src/openapi-builder/operationBuilder.ts:99

operationId

operationId(operationId: string): OperationBuilder
Add a operationId field to the Operation object.

Must be unique per document

Returns
OperationBuilder instances for method chaining
Parameters
- operationId: string
  
  The operationId string per OpenApiv3 spec
Returns OperationBuilder
- Defined in src/openapi-builder/operationBuilder.ts:112

parameters

parameters(parameters: (ReferenceObject | ParameterObject)[], excludeDefault?: boolean): OperationBuilder
Add a parameters field to the Operation object, will include defaults.

Returns
OperationBuilder instances for method chaining
Parameters
- parameters: (ReferenceObject | ParameterObject)[]
  
  The parameters object per OpenApiv3 spec
- excludeDefault: boolean = false
Returns OperationBuilder
- Defined in src/openapi-builder/operationBuilder.ts:123

requestBody

requestBody(requestBody: ReferenceObject | RequestBodyObject): OperationBuilder
Add a requestBody field to the Operation object.

Returns
OperationBuilder instances for method chaining
Parameters
- requestBody: ReferenceObject | RequestBodyObject
  
  The requestBody object per OpenApiv3 spec
Returns OperationBuilder
- Defined in src/openapi-builder/operationBuilder.ts:141

security

security(security: SecurityRequirementObject[]): OperationBuilder
Add a security field to the Operation object.

Returns
OperationBuilder instances for method chaining
Parameters
- security: SecurityRequirementObject[]
  
  The security object per OpenApiv3 spec
Returns OperationBuilder
- Defined in src/openapi-builder/operationBuilder.ts:176

servers

servers(servers: ServerObject[]): OperationBuilder
Add a servers field to the Operation object.

Returns
OperationBuilder instances for method chaining
Parameters
- servers: ServerObject[]
  
  The servers object per OpenApiv3 spec
Returns OperationBuilder
- Defined in src/openapi-builder/operationBuilder.ts:187

summary

summary(summary: string): OperationBuilder
Add a summary field to the Operation object

Returns
OperationBuilder instances for method chaining
Parameters
- summary: string
  
  The summary string per OpenApiv3 spec
Returns OperationBuilder
- Defined in src/openapi-builder/operationBuilder.ts:77

`Static` defaults

defaults(defaults: OperationDefaults): void
Sets defaults for the operation object when using the build interface
Parameters
- defaults: OperationDefaults
  
  The defaults to set - these are global to the OperationBuilder class
Returns void
- Defined in src/openapi-builder/operationBuilder.ts:23

`Static` new

new(responses: ResponsesObject): OperationBuilder
Start building a new Operation object

Returns
OperationBuilder instances for method chaining
Parameters
- responses: ResponsesObject
  
  The responses object - required by OpenApiv3
Returns OperationBuilder
- Defined in src/openapi-builder/operationBuilder.ts:32

Class OperationBuilder

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

responses: ResponsesObject

Returns OperationBuilder

Properties

Private Readonly _operation

Type declaration

Optional callbacks?: { [callback: string]: ReferenceObject | CallbackObject }

[callback: string]: ReferenceObject | CallbackObject

Optional deprecated?: boolean

Optional description?: string

Optional externalDocs?: ExternalDocumentationObject

Optional operationId?: string

Optional parameters?: (ReferenceObject | ParameterObject)[]

Optional requestBody?: ReferenceObject | RequestBodyObject

responses: ResponsesObject

Optional security?: SecurityRequirementObject[]

Optional servers?: ServerObject[]

Optional summary?: string

Optional tags?: string[]

Static Private Optional _defaults

Methods

b

Returns

Optional callbacks?: { [callback: string]: ReferenceObject | CallbackObject }

[callback: string]: ReferenceObject | CallbackObject

Optional deprecated?: boolean

Optional description?: string

Optional externalDocs?: ExternalDocumentationObject

Optional operationId?: string

Optional parameters?: (ReferenceObject | ParameterObject)[]

Optional requestBody?: ReferenceObject | RequestBodyObject

responses: ResponsesObject

Optional security?: SecurityRequirementObject[]

Optional servers?: ServerObject[]

Optional summary?: string

Optional tags?: string[]

build

Returns

Optional callbacks?: { [callback: string]: ReferenceObject | CallbackObject }

[callback: string]: ReferenceObject | CallbackObject

Optional deprecated?: boolean

Optional description?: string

Optional externalDocs?: ExternalDocumentationObject

Optional operationId?: string

Optional parameters?: (ReferenceObject | ParameterObject)[]

Optional requestBody?: ReferenceObject | RequestBodyObject

responses: ResponsesObject

Optional security?: SecurityRequirementObject[]

Optional servers?: ServerObject[]

Optional summary?: string

Optional tags?: string[]

callbacks

Returns

Parameters

callbacks: { [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject }

[callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject

Returns OperationBuilder

deprecated

Returns

Parameters

deprecated: boolean

Returns OperationBuilder

description

Returns

Parameters

description: string

Returns OperationBuilder

externalDocs

Returns

Parameters

externalDocObject: ExternalDocumentationObject

Returns OperationBuilder

`Private` constructor

`Private` `Readonly` _operation

`Optional` callbacks?: { [callback: string]: ReferenceObject | CallbackObject }

`Optional` deprecated?: boolean

`Optional` description?: string

`Optional` externalDocs?: ExternalDocumentationObject

`Optional` operationId?: string

`Optional` parameters?: (ReferenceObject | ParameterObject)[]

`Optional` requestBody?: ReferenceObject | RequestBodyObject

`Optional` security?: SecurityRequirementObject[]

`Optional` servers?: ServerObject[]

`Optional` summary?: string

`Optional` tags?: string[]

`Static` `Private` `Optional` _defaults

`Optional` callbacks?: { [callback: string]: ReferenceObject | CallbackObject }

`Optional` deprecated?: boolean

`Optional` description?: string

`Optional` externalDocs?: ExternalDocumentationObject

`Optional` operationId?: string

`Optional` parameters?: (ReferenceObject | ParameterObject)[]

`Optional` requestBody?: ReferenceObject | RequestBodyObject

`Optional` security?: SecurityRequirementObject[]

`Optional` servers?: ServerObject[]

`Optional` summary?: string

`Optional` tags?: string[]

`Optional` callbacks?: { [callback: string]: ReferenceObject | CallbackObject }

`Optional` deprecated?: boolean

`Optional` description?: string

`Optional` externalDocs?: ExternalDocumentationObject

`Optional` operationId?: string

`Optional` parameters?: (ReferenceObject | ParameterObject)[]

`Optional` requestBody?: ReferenceObject | RequestBodyObject

`Optional` security?: SecurityRequirementObject[]

`Optional` servers?: ServerObject[]

`Optional` summary?: string

`Optional` tags?: string[]

`Static` defaults

`Static` new