Interface IReference<Key>

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)

OpenApiV3.IJsonSchema.__IAttribute
- IReference

Index

Properties

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

Properties

$ref

$ref: Key

`Optional`deprecated

deprecated?: boolean

`Optional`description

description?: string

`Optional`example

example?: any

`Optional`examples

examples?: Record<string, any>

`Optional`title

title?: string