Interface __ISignificant<Type>

Significant attributes that can be applied to the most types.

interface __ISignificant<Type extends string> {
    deprecated?: boolean;
    description?: string;
    example?: any;
    examples?: Record<string, any>;
    title?: string;
    type: Type;
}

Type Parameters

  • Type extends string

Hierarchy (View Summary)

Properties

deprecated? description? example? examples? title? type

Properties

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.

type

type: Type

Discriminator value of the type.

Settings

Member Visibility

On This Page

Properties