Class DocsShape

Implements

IDocsShape

Index

Constructors

Methods

disable docs enable setConsumes setExamples setHost setLicense setLogo setPath setRedocOptions setResponses setSchemas setSwaggerUIOptions setTags setTagsGroup setTitle setVersion

Constructors

constructor

new DocsShape(): DocsShape
Returns DocsShape

Methods

disable

disable(): this
Returns this
- Defined in src/docs/shapes.ts:100

docs

docs(): DocsConfig
Returns DocsConfig
Implementation of IDocsShape.docs
- Defined in src/docs/shapes.ts:226

enable

enable(): this
Returns this
- Defined in src/docs/shapes.ts:105

setConsumes

setConsumes(mediaTypes): this
Parameters
- mediaTypes: string[]
Returns this
- Defined in src/docs/shapes.ts:120
setConsumes(...mediaTypes): this
Parameters
- Rest...mediaTypes: string[]
Returns this
- Defined in src/docs/shapes.ts:121

setExamples

setExamples(examples): this
Parameters
- examples: Iterable<ExampleShape>
Returns this
- Defined in src/docs/shapes.ts:199
setExamples(examples): this
Parameters
- examples: Record<string, ExampleObject | ReferenceObject>
Returns this
- Defined in src/docs/shapes.ts:200

setHost

setHost(url, description?, variables?): this
Parameters
- url: string
- Optionaldescription: string
- Optionalvariables: Record<string, ServerVariableObject>
Returns this
- Defined in src/docs/shapes.ts:179
setHost(server): this
Parameters
- server: ServerObject
Returns this
- Defined in src/docs/shapes.ts:180

setLicense

setLicense(name, url?): this
Parameters
- name: string
- Optionalurl: string
Returns this
- Defined in src/docs/shapes.ts:131
setLicense(license): this
Parameters
- license: LicenseObject
Returns this
- Defined in src/docs/shapes.ts:132

setLogo

setLogo(url, alt?): this
Parameters
- url: string
- Optionalalt: string
Returns this
- Defined in src/docs/shapes.ts:145
setLogo(logo): this
Parameters
- logo: DocsLogo
Returns this
- Defined in src/docs/shapes.ts:146

setPath

setPath(path): this
Parameters
- path: string
Returns this
- Defined in src/docs/shapes.ts:110

setRedocOptions

setRedocOptions(value): this
Parameters
- value: DocsRedocOptions
Returns this
- Defined in src/docs/shapes.ts:164

setResponses

setResponses(responses): this
Parameters
- responses: BaseResponseUtil
Returns this
- Defined in src/docs/shapes.ts:221

setSchemas

setSchemas(schemas): this
Parameters
- schemas: Iterable<SchemaShape>
Returns this
- Defined in src/docs/shapes.ts:210
setSchemas(schemas): this
Parameters
- schemas: Record<string, ReferenceObject | SchemaObject>
Returns this
- Defined in src/docs/shapes.ts:211

setSwaggerUIOptions

setSwaggerUIOptions(value): this
Parameters
- value: DocsSwaggerUIOptions
Returns this
- Defined in src/docs/shapes.ts:169

setTags

setTags(tags): this
Parameters
- tags: DocsTag[]
Returns this
- Defined in src/docs/shapes.ts:194

setTagsGroup

setTagsGroup(value): this
Parameters
- value: Record<string, string[]>
Returns this
- Defined in src/docs/shapes.ts:159

setTitle

setTitle(title): this
Parameters
- title: string
Returns this
- Defined in src/docs/shapes.ts:115

setVersion

setVersion(version): this
Parameters
- version: string
Returns this
- Defined in src/docs/shapes.ts:174