Class OpenapiInfoV3

OpenapiInfoV3 extends OpenAPIV3.Document and adds tagsToPaths variable

Hierarchy

OpenapiInfoV3

Index

Constructors

Properties

_api _components _info _openapi _paths _tagsToPaths

Accessors

api components info openapi paths tagsToPaths

Methods

_genComponents _genInfo _genOpenapi _genPaths _genTagsToPaths build parse parseAndBuild

Constructors

constructor

new OpenapiInfoV3(): OpenapiInfoV3
Returns OpenapiInfoV3
- Defined in structures/openapiInfo.ts:25

Properties

`Private` _api

_api: Document<{}>

`Private` _components

_components: ComponentsObject

`Private` _info

_info: InfoObject

`Private` _openapi

_openapi: string

`Private` _paths

_paths: Record<string, PathItemObject<{}>>

`Private` _tagsToPaths

_tagsToPaths: Record<string, OperationObjectWithPath[]>

Accessors

api

get api(): Document<{}>
Returns api

Returns Document<{}>
- Defined in structures/openapiInfo.ts:85

components

get components(): ComponentsObject
Returns components

Returns ComponentsObject
- Defined in structures/openapiInfo.ts:99

info

get info(): InfoObject
Returns info

Returns InfoObject
- Defined in structures/openapiInfo.ts:92

openapi

get openapi(): string
Returns openapi

Returns string
- Defined in structures/openapiInfo.ts:106

paths

get paths(): Record<string, PathItemObject<{}>>
Returns paths

Returns Record<string, PathItemObject<{}>>
- Defined in structures/openapiInfo.ts:113

tagsToPaths

get tagsToPaths(): Record<string, OperationObjectWithPath[]>
Returns tagsToPaths

Returns Record<string, OperationObjectWithPath[]>
- Defined in structures/openapiInfo.ts:120

Methods

`Private` _genComponents

_genComponents(): Promise<ComponentsObject>
Generates components from _api

Returns Promise<ComponentsObject>
- Defined in structures/openapiInfo.ts:39

`Private` _genInfo

_genInfo(): Promise<InfoObject>
Generates info from _api

Returns Promise<InfoObject>
- Defined in structures/openapiInfo.ts:51

`Private` _genOpenapi

_genOpenapi(): Promise<string>
Generates openapi from _api

Returns Promise<string>
- Defined in structures/openapiInfo.ts:63

`Private` _genPaths

_genPaths(): Promise<Record<string, PathItemObject<{}>>>
Generates paths from _api

Returns Promise<Record<string, PathItemObject<{}>>>
- Defined in structures/openapiInfo.ts:75

`Private` _genTagsToPaths

_genTagsToPaths(paths): Promise<Record<string, OperationObjectWithPath[]>>
Generates tagsToPaths from _api.paths
Parameters
- paths: Record<string, PathItemObject<{}>>
Returns Promise<Record<string, OperationObjectWithPath[]>>
- Defined in structures/openapiInfo.ts:130

build

build(): Promise<void>
Build data from _api

Returns Promise<void>
- Defined in structures/openapiInfo.ts:175

parse

parse(apiPath): Promise<void>
Parser data from apiPath
Parameters
- apiPath: string | Document<{}>
Returns Promise<void>
- Defined in structures/openapiInfo.ts:167

parseAndBuild

parseAndBuild(apiPath): Promise<void>
Parse and build OpenapiInfoV3 by apiPath
Parameters
- apiPath: string | Document<{}>
Returns Promise<void>
- Defined in structures/openapiInfo.ts:188

Generated using TypeDoc