api-morph / ReferenceObject

Interface: ReferenceObject

Defined in: src/types/openapi.ts:1007

A simple object to allow referencing other components in the OpenAPI Description, internally and externally.

See

https://spec.openapis.org/oas/v3.1.1#reference-object

Properties

$ref

$ref: string

Defined in: src/types/openapi.ts:1011

REQUIRED. The reference identifier. This MUST be in the form of a URI.

---

description?

optional description: string

Defined in: src/types/openapi.ts:1024

A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.

---

summary?

optional summary: string

Defined in: src/types/openapi.ts:1017

A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect.