Interface ObjectSchema

interface ObjectSchema {
    $comment?: string;
    $id?: string;
    additionalProperties?: boolean | Schema;
    allOf?: Partial<Schema>[];
    anyOf?: Partial<Schema>[];
    default?: any;
    definitions?: Record<string, Schema>;
    description?: string;
    else?: Partial<Schema>;
    examples?: any[];
    if?: Partial<Schema>;
    nullable?: boolean;
    patternProperties?: ObjectProperties;
    properties?: ObjectProperties;
    required?: string[];
    then?: Partial<Schema>;
    title?: string;
    type: "object";
}

Hierarchy (view full)

Properties

$comment? $id? additionalProperties? allOf? anyOf? default? definitions? description? else? examples? if? nullable? patternProperties? properties? required? then? title? type

Properties

Optional $comment

$comment?: string

A comment to be added to the schema

Optional $id

$id?: string

Schema id

Optional additionalProperties

additionalProperties?: boolean | Schema

Specifies whether additional properties on the object are allowed, and optionally what schema they should adhere to

Default

false

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

Optional nullable

nullable?: boolean

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

Default

false

Optional patternProperties

patternProperties?: ObjectProperties

Describe properties that have keys following a given pattern

Optional properties

properties?: ObjectProperties

Describe the properties of the object

Optional required

required?: string[]

The required properties of the object

Optional then

then?: Partial<Schema>

A schema to apply if the conditional schema from if passes

Optional title

title?: string

Schema title

type

type: "object"

Settings

Member Visibility

Theme

On This Page

$comment$idadditionalPropertiesallOfanyOfdefaultdefinitionsdescriptionelseexamplesifnullablepatternPropertiespropertiesrequiredthentitletype