Interface ReferenceObject

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

The $ref string value contains a URI [RFC3986], which identifies the location of the value being referenced.

See the rules for resolving Relative References.

Note that this restriction on additional properties is a difference between Reference Objects and Schema Objects that contain a $ref keyword.

See

https://spec.openapis.org/oas/latest.html#reference-object

interface ReferenceObject {
    $ref: string;
    description?: string;
    summary?: string;
}

Properties

$ref description? summary?

Properties

$ref

$ref: string

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

Optional description

description?: string

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.

Optional summary

summary?: string

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.

Settings

Member Visibility

Theme

On This Page

$refdescriptionsummary