Interface IReference

Reference type directing named schema.

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

Hierarchy (View Summary)

Properties

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

Properties

$ref

$ref: string

Reference to the named schema.

The ref is a reference to the named schema. Format of the $ref is following the JSON Pointer specification. In the OpenAPI, the $ref starts with #/$defs/ which means the type is stored in the ILlmSchemaV3_1.IParameters.$defs object.

  • #/$defs/SomeObject
  • #/$defs/AnotherObject

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?: Record<string, any>

List of example values as key-value pairs.

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