Interface ArraySchema

interface ArraySchema {
    $comment?: string;
    $id?: string;
    allOf?: Partial<Schema>[];
    anyOf?: Partial<Schema>[];
    default?: any;
    definitions?: Record<string, Schema>;
    description?: string;
    else?: Partial<Schema>;
    examples?: any[];
    if?: Partial<Schema>;
    items: {} | Schema;
    nullable?: boolean;
    then?: Partial<Schema>;
    title?: string;
    type: "array";
}

Hierarchy (view full)

Properties

$comment? $id? allOf? anyOf? default? definitions? description? else? examples? if? items nullable? then? title? type

Properties

Optional $comment

$comment?: string

A comment to be added to the schema

Optional $id

$id?: string

Schema id

Optional allOf

allOf?: Partial<Schema>[]

A set of schemas which must all match

Optional anyOf

anyOf?: Partial<Schema>[]

A set of schemas of which at least one must match

Optional default

default?: any

Default value to be assigned when no value is given in the document

Optional definitions

definitions?: Record<string, Schema>

Additional schema definition to reference from within the schema

Optional description

description?: string

Schema description

Optional else

else?: Partial<Schema>

A schema to apply if the conditional schema from if fails

Optional examples

examples?: any[]

A list of example values that match this schema

Optional if

if?: Partial<Schema>

A conditional schema to check, controls schemas defined in then and else

items

items: {} | Schema

The schema for the items in the array

Type declaration

    Optional nullable

    nullable?: boolean

    Open API 3.0 spec states that any value that can be null must be declared nullable

    Default

    false

    Optional then

    then?: Partial<Schema>

    A schema to apply if the conditional schema from if passes

    Optional title

    title?: string

    Schema title

    type

    type: "array"

    Settings

    Member Visibility

    Theme

    On This Page

    $comment$idallOfanyOfdefaultdefinitionsdescriptionelseexamplesifitemsnullablethentitletype