Interface Extendable

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.

The extensions properties are implemented as patterned fields that are always prefixed by "x-".

The extensions may or may not be supported by the available tooling, but those may be extended as well to add requested support (if tools are internal or open-sourced).

See

https://spec.openapis.org/oas/latest.html#specification-extensions

interface Extendable {
    [key: `x-${string}`]: any;
}

Hierarchy (view full)

Indexable

[key: `x-${string}`]: any

Allows extensions to the OpenAPI Schema. The field name MUST begin with x-, for example, x-internal-id. Field names beginning x-oai- and x-oas- are reserved for uses defined by the OpenAPI Initiative. The value can be null, a primitive, an array or an object.

Settings

Member Visibility

Theme