parameterobject.md

fastify-oas

Globals / ParameterObject

Interface: ParameterObject

Hierarchy

• BaseParameterObject

  ↳ ParameterObject

Indexable

▪ [extensionName: string]: any

Index

Properties

• allowEmptyValue
• allowReserved
• content
• deprecated
• description
• example
• examples
• explode
• in
• name
• required
• schema
• style

Properties

allowEmptyValue

• Optional allowEmptyValue: boolean

Inherited from BaseParameterObject.allowEmptyValue

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:116

---

allowReserved

• Optional allowReserved: boolean

Inherited from BaseParameterObject.allowReserved

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:119

---

content

• Optional content: ContentObject

Inherited from BaseParameterObject.content

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:125

---

deprecated

• Optional deprecated: boolean

Inherited from BaseParameterObject.deprecated

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:115

---

description

• Optional description: string

Inherited from BaseParameterObject.description

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:113

---

example

• Optional example: any

Inherited from BaseParameterObject.example

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:124

---

examples

• Optional examples: { [param:string]: ExampleObject | ReferenceObject; }

Inherited from BaseParameterObject.examples

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:121

---

explode

• Optional explode: boolean

Inherited from BaseParameterObject.explode

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:118

---

in

• in: ParameterLocation

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:129

---

name

• name: string

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:128

---

required

• Optional required: boolean

Inherited from BaseParameterObject.required

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:114

---

schema

• Optional schema: SchemaObject | ReferenceObject

Inherited from BaseParameterObject.schema

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:120

---

style

• Optional style: ParameterStyle

Inherited from BaseParameterObject.style

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:117