Interface IReference

Reference type directing to named schema.

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

Hierarchy (View Summary)

Properties

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

Properties

$ref

$ref: string

Reference to the named schema.

The $ref is a reference to a named schema. The format follows the JSON Pointer specification. In OpenAPI, the $ref starts with #/$defs/ which indicates the type is stored in the IGeminiSchema.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.

Optionaltitle

title?: string

Title of the schema.

Settings

Member Visibility

On This Page

Properties