Class OpenAPIConfig

Class representing the OpenAPI configuration.

OpenAPIConfig

Hierarchy

Construct
- OpenAPIConfig

Index

Constructors

Properties

Methods

toString toYaml isConstruct

Constructors

constructor

new OpenAPIConfig(
    scope: Construct,
    id: string,
    props: OpenAPIProps,
): OpenAPIConfig
Creates an instance of OpenAPIConfig.
Parameters
- scope: Construct
  The scope in which this construct is defined.
- id: string
  The ID of the construct.
- props: OpenAPIProps
  The properties of the OpenAPI configuration.
Returns OpenAPIConfig
Overrides Construct.constructor
- Defined in src/constructs/openApi/index.ts:26

Properties

config

config: IOpenAPI

`Readonly`node

node: Node

The tree node.

Stability

stable

Methods

toString

toString(): string
Returns a string representation of this construct.

Returns string
Stability
stable
Inherited from Construct.toString
- Defined in node_modules/constructs/lib/construct.d.ts:319

toYaml

toYaml(): IOpenAPI
Returns IOpenAPI
- Defined in src/constructs/openApi/index.ts:37

`Static`isConstruct

isConstruct(x: any): x is Construct
(deprecated) Checks if x is a construct.
Parameters
- x: any
  Any object.
Returns x is Construct
true if x is an object created from a class which extends Construct.

Deprecated
use x instanceof Construct instead
Inherited from Construct.isConstruct
- Defined in node_modules/constructs/lib/construct.d.ts:299