Class Plyex

Hierarchy

Plyex

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Plyex(plugin: string, logger: Log, options?: PlyexOptions): Plyex

- Defined in src/plyex/plyex.ts:50
Parameters
- plugin: string
- logger: Log
- Optional options: PlyexOptions
Returns Plyex

Properties

Readonly logger

logger: Log

Readonly options

options: PlyexOptions

Readonly plugin

plugin: string

Methods

augment

augment(openApi: OpenApi, endpointMethods?: EndpointMethod[]): Promise<OpenApi>

- Defined in src/plyex/plyex.ts:63
Parameters
- openApi: OpenApi
- Optional endpointMethods: EndpointMethod[]
Returns Promise<OpenApi>

codeSamples

codeSamples(operation: Operation, endpointMethod: EndpointMethod, schemaType: string, example: any): void

- Defined in src/plyex/plyex.ts:254
Parameters
- operation: Operation
- endpointMethod: EndpointMethod
- schemaType: string
- example: any
Returns void

doAugment

doAugment(openApi: OpenApi, endpointMethods: EndpointMethod[]): Promise<OpenApi>

- Defined in src/plyex/plyex.ts:86
Parameters
- openApi: OpenApi
- endpointMethods: EndpointMethod[]
Returns Promise<OpenApi>

examples

examples(endpointMethod: EndpointMethod, operation: Operation, plyEndpointMeta: PlyEndpointMeta): void

- Defined in src/plyex/plyex.ts:157
Parameters
- endpointMethod: EndpointMethod
- operation: Operation
- plyEndpointMeta: PlyEndpointMeta
Returns void

getPluginEndpointMethods

getPluginEndpointMethods(): EndpointMethod[]

- Defined in src/plyex/plyex.ts:55
Returns EndpointMethod[]

operation

operation(endpointMethod: EndpointMethod): Operation

- Defined in src/plyex/plyex.ts:150
Parameters
- endpointMethod: EndpointMethod
Returns Operation

schemaType

schemaType(jsonPayload: Media): string

- Defined in src/plyex/plyex.ts:240
Parameters
- jsonPayload: Media
Returns string

typeName

typeName(schemaType: string): string

- Defined in src/plyex/plyex.ts:306
Parameters
- schemaType: string
Returns string

Generated using TypeDoc