Interface IReference

Reference type directing named schema.

interface IReference {
    $ref: string;
    description: string;
    "x-autobe-database-schema-property"?: string | null;
    "x-autobe-specification"?: string;
}

Hierarchy (View Summary)

IProperty
AutoBeOpenApi.IJsonSchema.IReference
- IReference

Index

Properties

$ref description x-autobe-database-schema-property? x-autobe-specification?

Properties

$ref

$ref: string

JSON Pointer reference to a named schema (e.g., #/components/schemas/SomeObject).

description

description: string

`Optional`x-autobe-database-schema-property

"x-autobe-database-schema-property"?: string | null

`Optional`x-autobe-specification

"x-autobe-specification"?: string