@typia/website
    Preparing search index...

    Interface IReference<Key>

    Reference type directing named schema.

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

    Type Parameters

    • Key = string

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    $ref: Key

    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 #/components/schemas/ which means the type is stored in the OpenApi.IComponents.schemas object.

    • #/components/schemas/SomeObject
    • #/components/schemas/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.

    title?: string

    Title of the schema.

    Settings

    Member Visibility

    On This Page

    Properties