Interface IObject

Common attributes for object types.

interface IObject {
    additionalProperties?: boolean | OpenApiV3.IJsonSchema;
    deprecated?: boolean;
    description?: string;
    example?: any;
    examples?: Record<string, any>;
    maxProperties?: number;
    minProperties?: number;
    nullable?: boolean;
    properties?: Record<string, OpenApiV3.IJsonSchema>;
    required?: string[];
    title?: string;
    type: "object";
}

Hierarchy (View Summary)

Properties

additionalProperties? deprecated? description? example? examples? maxProperties? minProperties? nullable? properties? required? title? type

Properties

OptionaladditionalProperties

additionalProperties?: boolean | OpenApiV3.IJsonSchema

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.

OptionalmaxProperties

maxProperties?: number

OptionalminProperties

minProperties?: number

Optionalnullable

nullable?: boolean

Optionalproperties

properties?: Record<string, OpenApiV3.IJsonSchema>

Optionalrequired

required?: string[]

Optionaltitle

title?: string

Title of the schema.

type

type: "object"

Discriminator value of the type.

Settings

Member Visibility

On This Page

Properties