Interface OpenApiPath

interface OpenApiPath {
    addEndpoints(
        mappings: Partial<{ [K in string]: OpenApiPathItem }>,
    ): this;
    addExtensions(mappings: { [key: `x-${string}`]: OpenApiSchema }): this;
    override(overrideVal: unknown): this;
    toJSON(): unknown;
}

Hierarchy

BaseInterface
- OpenApiPath

Index

Methods

addEndpoints addExtensions override toJSON

Methods

addEndpoints

addEndpoints(mappings: Partial<{ [K in string]: OpenApiPathItem }>): this
Adds endpoints to the OpenAPI specification.
Parameters
- mappings: Partial<{ [K in string]: OpenApiPathItem }>
  a mapping between API routes and PathItems
Returns this
this
- Defined in core/openapiv3/lib/OpenApiPath.ts:13

addExtensions

addExtensions(mappings: { [key: `x-${string}`]: OpenApiSchema }): this
Extend the specification with an extension object schema.
Parameters
- mappings: { [key: `x-${string}`]: OpenApiSchema }
  key value mappings with names MUST beginning with "x-"
Returns this
Inherited from BaseInterface.addExtensions
- Defined in core/openapiv3/lib/base.ts:50

override

override(overrideVal: unknown): this
Overrides the toJSON method for a custom serialization.

WARNING: overrideVal must be serializable and future changes are subject to breaking.
Parameters
- overrideVal: unknown
  Overrides the serialization of this object into this value.
Returns this
Inherited from BaseInterface.override
- Defined in core/openapiv3/lib/base.ts:41

toJSON

toJSON(): unknown
Serializes the object into its equivalent OpenApi JSON value.

Returns unknown
Inherited from BaseInterface.toJSON
- Defined in core/openapiv3/lib/base.ts:33

Interface OpenApiPath

Hierarchy

Index

Methods

Methods

addEndpoints

Parameters

Returns this

addExtensions

Parameters

Returns this

override

Parameters

Returns this

toJSON

Returns unknown

Settings

On This Page