Skip to content

TypeScript API / laikacms/json-api / OpenApiRef

Interface: OpenApiRef ​

An OpenAPI 3.1 Reference Object, used where a document points at #/components/... instead of inlining the object.

summary and description are siblings 3.1 permits next to $ref; they override the referenced object's own, which is what lets a shared error response carry a per-operation description.

Properties ​

$ref ​

ts
$ref: string;

description? ​

ts
optional description?: string;

summary? ​

ts
optional summary?: string;

Released under the MIT License.