Interface IReference<Key>

interface IReference<Key = string> {
    $ref: Key;
    deprecated?: boolean;
    description?: string;
    example?: any;
    examples?: any[] | Record<string, any>;
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}

Type Parameters

  • Key = string

Hierarchy (View Summary)

Properties

$ref deprecated? description? example? examples? readOnly? title? writeOnly?

Properties

$ref

$ref: Key

Optionaldeprecated

deprecated?: boolean

Whether the type is deprecated or not.

Optionaldescription

description?: string

Detailed description of the schema.

Optionalexample

example?: any

Example value.

Optionalexamples

examples?: any[] | Record<string, any>

OptionalreadOnly

readOnly?: boolean

Whether the property is read-only.

Optionaltitle

title?: string

Title of the schema.

OptionalwriteOnly

writeOnly?: boolean

Whether the property is write-only.

Settings

Member Visibility

On This Page

Properties