@typia/website
    Preparing search index...

    Interface IReference

    Reference type directing to named schema.

    If IConfig.strict mode is enabled, its other properties like description would be disabled. Instead, the description would be placed in the parent type. For example, if this reference type is used as a property of an object, the description would be placed in the object place.

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    $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 ILlmSchema.IParameters.$defs object.

    • #/$defs/SomeObject
    • #/$defs/AnotherObject
    deprecated?: boolean

    Whether the type is deprecated or not.

    description?: string

    Detailed description of the schema.

    example?: any

    Example value.

    examples?: Record<string, any>

    List of example values as key-value pairs.

    readOnly?: boolean

    Whether the property is read-only.

    title?: string

    Title of the schema.

    writeOnly?: boolean

    Whether the property is write-only.

    Settings

    Member Visibility

    On This Page

    Properties