Interface IObject

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

Hierarchy (View Summary)

Properties

additionalProperties? deprecated? description? example? examples? maxProperties? minProperties? properties? readOnly? required? title? type writeOnly? x-nullable?

Properties

OptionaladditionalProperties

additionalProperties?: boolean | SwaggerV2.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?: any[]

OptionalmaxProperties

maxProperties?: number

OptionalminProperties

minProperties?: number

Optionalproperties

properties?: Record<string, SwaggerV2.IJsonSchema>

OptionalreadOnly

readOnly?: boolean

Whether the property is read-only.

Optionalrequired

required?: string[]

Optionaltitle

title?: string

Title of the schema.

type

type: "object"

Discriminator value of the type.

OptionalwriteOnly

writeOnly?: boolean

Whether the property is write-only.

Optionalx-nullable

"x-nullable"?: boolean

Settings

Member Visibility

On This Page

Properties