README.md

fastify-oas

Globals

fastify-oas

Index

Modules

• "fastify"

Namespaces

• fastifyOAS

Classes

• Server
• ServerVariable
• SpecificationExtension

Interfaces

• ApiKeySecurity
• BaseOAuthSecurity
• BaseParameterObject
• BaseSecurity
• BasicAuthenticationSecurity
• CallbackObject
• CallbacksObject
• ComponentsObject
• Contact
• ContactObject
• ContentObject
• DiscriminatorObject
• EncodingObject
• EncodingPropertyObject
• ExampleObject
• ExamplesObject
• ExternalDocs
• ExternalDocumentationObject
• Header
• HeaderObject
• HeadersObject
• ISpecificationExtension
• Info
• InfoObject
• License
• LicenseObject
• LinkObject
• LinkParametersObject
• LinksObject
• MediaTypeObject
• OAuth2AccessCodeSecurity
• OAuth2ApplicationSecurity
• OAuth2ImplicitSecurity
• OAuth2PasswordSecurity
• OAuthFlowObject
• OAuthFlowsObject
• OAuthScope
• OpenAPIObject
• Operation
• OperationObject
• ParameterObject
• Path
• PathItemObject
• PathsObject
• Reference
• ReferenceObject
• RequestBodyObject
• Response
• ResponseObject
• ResponsesObject
• Schema
• SchemaObject
• SchemasObject
• ScopesObject
• SecurityRequirementObject
• SecuritySchemeObject
• ServerObject
• ServerVariableObject
• Spec
• Tag
• TagObject
• XML
• XmlObject

Type aliases

• BaseFormatContrainedParameter
• BaseParameter
• BaseSchema
• BodyParameter
• FormDataParameter
• GenericFormat
• HeaderParameter
• IntegerFormat
• NumberFormat
• Parameter
• ParameterCollectionFormat
• ParameterLocation
• ParameterStyle
• ParameterType
• PathObject
• PathParameter
• QueryParameter
• SchemaFormatConstraints
• Security
• SecuritySchemeType
• StringFormat

Functions

• addExtension
• getExtension
• getPath
• isReferenceObject
• isSchemaObject

Type aliases

BaseFormatContrainedParameter

Ƭ BaseFormatContrainedParameter: BaseParameter & SchemaFormatConstraints

Defined in node_modules/@types/swagger-schema-official/index.d.ts:79

---

BaseParameter

Ƭ BaseParameter: { description?: string ; in: "body" | "query" | "path" | "header" | "formData" | "body" ; name: string ; required?: boolean }

Defined in node_modules/@types/swagger-schema-official/index.d.ts:46

Type declaration:

Name	Type
description?	string
in	"body" | "query" | "path" | "header" | "formData" | "body"
name	string
required?	boolean

---

BaseSchema

Ƭ BaseSchema: { default?: any ; description?: string ; enum?: any[] ; exclusiveMaximum?: boolean ; exclusiveMinimum?: boolean ; format?: string ; items?: Schema | Schema[] ; maxItems?: number ; maxLength?: number ; maxProperties?: number ; maximum?: number ; minItems?: number ; minLength?: number ; minProperties?: number ; minimum?: number ; multipleOf?: number ; pattern?: string ; title?: string ; type?: ParameterType ; uniqueItems?: boolean }

Defined in node_modules/@types/swagger-schema-official/index.d.ts:153

Type declaration:

Name	Type
default?	any
description?	string
enum?	any[]
exclusiveMaximum?	boolean
exclusiveMinimum?	boolean
format?	string
items?	Schema | Schema[]
maxItems?	number
maxLength?	number
maxProperties?	number
maximum?	number
minItems?	number
minLength?	number
minProperties?	number
minimum?	number
multipleOf?	number
pattern?	string
title?	string
type?	ParameterType
uniqueItems?	boolean

---

BodyParameter

Ƭ BodyParameter: BaseParameter & { in: "body" ; schema?: Schema }

Defined in node_modules/@types/swagger-schema-official/index.d.ts:53

---

FormDataParameter

Ƭ FormDataParameter: BaseFormatContrainedParameter & BaseSchema & { allowEmptyValue?: boolean ; collectionFormat?: ParameterCollectionFormat ; in: "formData" ; type: ParameterType | "file" }

Defined in node_modules/@types/swagger-schema-official/index.d.ts:100

---

GenericFormat

Ƭ GenericFormat: { format?: string ; type?: ParameterType }

Defined in node_modules/@types/swagger-schema-official/index.d.ts:58

Type declaration:

Name	Type
format?	string
type?	ParameterType

---

HeaderParameter

Ƭ HeaderParameter: BaseFormatContrainedParameter & BaseSchema & { in: "header" }

Defined in node_modules/@types/swagger-schema-official/index.d.ts:95

---

IntegerFormat

Ƭ IntegerFormat: { format?: "int32" | "int64" ; type: "integer" }

Defined in node_modules/@types/swagger-schema-official/index.d.ts:63

Type declaration:

Name	Type
format?	"int32" | "int64"
type	"integer"

---

NumberFormat

Ƭ NumberFormat: { format?: "float" | "double" ; type: "number" }

Defined in node_modules/@types/swagger-schema-official/index.d.ts:68

Type declaration:

Name	Type
format?	"float" | "double"
type	"number"

---

Parameter

Ƭ Parameter: BodyParameter | FormDataParameter | QueryParameter | PathParameter | HeaderParameter

Defined in node_modules/@types/swagger-schema-official/index.d.ts:108

---

ParameterCollectionFormat

Ƭ ParameterCollectionFormat: "csv" | "ssv" | "tsv" | "pipes" | "multi"

Defined in node_modules/@types/swagger-schema-official/index.d.ts:80

---

ParameterLocation

Ƭ ParameterLocation: "query" | "header" | "path" | "cookie"

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

---

ParameterStyle

Ƭ ParameterStyle: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject"

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

---

ParameterType

Ƭ ParameterType: "string" | "number" | "integer" | "boolean" | "array" | "object" | "file"

Defined in node_modules/@types/swagger-schema-official/index.d.ts:44

---

PathObject

Ƭ PathObject: PathsObject

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

---

PathParameter

Ƭ PathParameter: BaseFormatContrainedParameter & BaseSchema & { in: "path" ; required: true }

Defined in node_modules/@types/swagger-schema-official/index.d.ts:89

---

QueryParameter

Ƭ QueryParameter: BaseFormatContrainedParameter & BaseSchema & { allowEmptyValue?: boolean ; collectionFormat?: ParameterCollectionFormat ; in: "query" }

Defined in node_modules/@types/swagger-schema-official/index.d.ts:82

---

SchemaFormatConstraints

Ƭ SchemaFormatConstraints: GenericFormat | IntegerFormat | NumberFormat | StringFormat

Defined in node_modules/@types/swagger-schema-official/index.d.ts:78

---

Security

Ƭ Security: BasicAuthenticationSecurity | OAuth2AccessCodeSecurity | OAuth2ApplicationSecurity | OAuth2ImplicitSecurity | OAuth2PasswordSecurity | ApiKeySecurity

Defined in node_modules/@types/swagger-schema-official/index.d.ts:248

---

SecuritySchemeType

Ƭ SecuritySchemeType: "apiKey" | "http" | "oauth2" | "openIdConnect"

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

---

StringFormat

Ƭ StringFormat: { format?: "" | "byte" | "binary" | "date" | "date-time" | "password" ; type: "string" }

Defined in node_modules/@types/swagger-schema-official/index.d.ts:73

Type declaration:

Name	Type
format?	"" | "byte" | "binary" | "date" | "date-time" | "password"
type	"string"

Functions

addExtension

▸ addExtension(obj: ISpecificationExtension, extensionName: string, extension: any): void

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

Parameters:

Name	Type
obj	ISpecificationExtension
extensionName	string
extension	any

Returns: void

---

getExtension

▸ getExtension(obj: ISpecificationExtension, extensionName: string): any

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

Parameters:

Name	Type
obj	ISpecificationExtension
extensionName	string

Returns: any

---

getPath

▸ getPath(pathsObject: PathsObject, path: string): PathItemObject | undefined

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

Parameters:

Name	Type
pathsObject	PathsObject
path	string

Returns: PathItemObject | undefined

---

isReferenceObject

▸ isReferenceObject(obj: object): obj is ReferenceObject

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

Parameters:

Name	Type
obj	object

Returns: obj is ReferenceObject

---

isSchemaObject

▸ isSchemaObject(schema: SchemaObject | ReferenceObject): schema is SchemaObject

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

Parameters:

Name	Type
schema	SchemaObject | ReferenceObject

Returns: schema is SchemaObject