Class ParameterBuilder

Hierarchy

ParameterBuilder

Index

Constructors

Properties

Methods

b booleanType build deprecated example integerType isRequired numberType schema stringType cookie header path query

Constructors

`Private` constructor

new ParameterBuilder(name: string, _in: string): ParameterBuilder
Parameters
- name: string
- _in: string
Returns ParameterBuilder
- Defined in src/openapi-builder/parameterBuilder.ts:45

Properties

`Private` `Readonly` _parameter

_parameter: ParameterObject

Methods

b

b(): ParameterObject
Shorthand for build() method.

Returns
A deep copy of the built parameter object

Returns ParameterObject
- Defined in src/openapi-builder/parameterBuilder.ts:150

booleanType

booleanType(): ParameterObject
Sets the parameter's schema to be a simple boolean type. Used to offer quick complete - does not require .build()

Returns
A complete OpenApiv3 parameter object

Returns ParameterObject
- Defined in src/openapi-builder/parameterBuilder.ts:89

build

build(): ParameterObject
Creates a deep copy of the current state of the parameter object and returns it.

Returns
A deep copy of the built parameter object

Returns ParameterObject
- Defined in src/openapi-builder/parameterBuilder.ts:141

deprecated

deprecated(deprecated??: boolean): ParameterBuilder
Sets the deprecated field, defaults to true

Returns
ParameterBuilder instance for method chaining
Parameters
- Optional deprecated: boolean = true
  
  Deprecated flag
Returns ParameterBuilder
- Defined in src/openapi-builder/parameterBuilder.ts:68

example

example(example: any): ParameterBuilder
Sets the parameter's schema field

Returns
ParameterBuilder instance for method chaining
Parameters
- example: any
Returns ParameterBuilder
- Defined in src/openapi-builder/parameterBuilder.ts:130

integerType

integerType(): ParameterObject
Sets the parameter's schema to be a simple integer type. Used to offer quick complete - does not require .build()

Returns
A complete OpenApiv3 parameter object

Returns ParameterObject
- Defined in src/openapi-builder/parameterBuilder.ts:100

isRequired

isRequired(required??: boolean): ParameterBuilder
Sets the required field, defaults to true

Returns
ParameterBuilder instance for method chaining
Parameters
- Optional required: boolean = true
  
  Required flag
Returns ParameterBuilder
- Defined in src/openapi-builder/parameterBuilder.ts:58

numberType

numberType(): ParameterObject
Sets the parameter's schema to be a simple number type. Used to offer quick complete - does not require .build()

Returns
A complete OpenApiv3 parameter object

Returns ParameterObject
- Defined in src/openapi-builder/parameterBuilder.ts:111

schema

schema(schema: SchemaObject): ParameterBuilder
Sets the parameter's schema field

Returns
ParameterBuilder instance for method chaining
Parameters
- schema: SchemaObject
Returns ParameterBuilder
- Defined in src/openapi-builder/parameterBuilder.ts:120

stringType

stringType(): ParameterObject
Sets the parameter's schema to be a simple string type. Used to offer quick complete - does not require .build()

Returns
A complete OpenApiv3 parameter object

Returns ParameterObject
- Defined in src/openapi-builder/parameterBuilder.ts:78

`Static` cookie

cookie(name: string): ParameterBuilder
Starts building a cookie parameter object

Returns
ParameterBuilder instance for method chaining
Parameters
- name: string
  
  The name of the parameter
Returns ParameterBuilder
- Defined in src/openapi-builder/parameterBuilder.ts:41

`Static` header

header(name: string): ParameterBuilder
Starts building a header parameter object

Returns
ParameterBuilder instance for method chaining
Parameters
- name: string
  
  The name of the parameter
Returns ParameterBuilder
- Defined in src/openapi-builder/parameterBuilder.ts:32

`Static` path

path(name: string): ParameterBuilder
Starts building a path parameter object

Returns
ParameterBuilder instance for method chaining
Parameters
- name: string
  
  The name of the parameter
Returns ParameterBuilder
- Defined in src/openapi-builder/parameterBuilder.ts:14

`Static` query

query(name: string): ParameterBuilder
Starts building a query parameter object

Returns
ParameterBuilder instance for method chaining
Parameters
- name: string
  
  The name of the parameter
Returns ParameterBuilder
- Defined in src/openapi-builder/parameterBuilder.ts:23

Generated using TypeDoc