Interface IObject

Object type info.

interface IObject {
    additionalProperties?:
        | false
        | AutoBeOpenApi.IJsonSchema.IInteger
        | AutoBeOpenApi.IJsonSchema.INumber
        | AutoBeOpenApi.IJsonSchema.IString
        | AutoBeOpenApi.IJsonSchema.IConstant
        | AutoBeOpenApi.IJsonSchema.IBoolean
        | AutoBeOpenApi.IJsonSchema.IArray
        | AutoBeOpenApi.IJsonSchema.IReference
        | AutoBeOpenApi.IJsonSchema.IOneOf
        | AutoBeOpenApi.IJsonSchema.INull;
    properties: Record<string, AutoBeOpenApi.IJsonSchema>;
    required: string[];
    type: "object";
}

Hierarchy (View Summary)

ISignificant<"object">
- IObject
  - AutoBeOpenApi.IJsonSchemaDescriptive.IObject

Index

Properties

additionalProperties? properties required type

Properties

`Optional`additionalProperties

additionalProperties?:
    | false
    | AutoBeOpenApi.IJsonSchema.IInteger
    | AutoBeOpenApi.IJsonSchema.INumber
    | AutoBeOpenApi.IJsonSchema.IString
    | AutoBeOpenApi.IJsonSchema.IConstant
    | AutoBeOpenApi.IJsonSchema.IBoolean
    | AutoBeOpenApi.IJsonSchema.IArray
    | AutoBeOpenApi.IJsonSchema.IReference
    | AutoBeOpenApi.IJsonSchema.IOneOf
    | AutoBeOpenApi.IJsonSchema.INull

Schema for dynamic keys (Record<string, T>), or false if no additional properties are allowed.

properties

properties: Record<string, AutoBeOpenApi.IJsonSchema>

Key-value pairs of the object's named properties.

required

required: string[]

Property keys that must be present. Properties not listed here are optional.

type

type: "object"

Discriminator value. MUST be a single string, NEVER an array.

For nullable types, use IOneOf instead: { oneOf: [{ type: "string" }, { type: "null" }] }