Reference

class Reference(d: dict[str, Any] = None, ref: str = None, summary: str = None, description: str = None)

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

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

See the rules for resolving Relative References.

property ref: str

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

property summary: str | None

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.

property description: str | None

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.