AutoBE
    Preparing search index...

    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;
        description: string;
        properties: Record<string, IJsonSchemaProperty>;
        required: string[];
        type: "object";
        "x-autobe-specification"?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    additionalProperties? description properties required type x-autobe-specification?

    Properties

    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.

    description: string
    properties: Record<string, IJsonSchemaProperty>

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

    required: string[]

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

    type: "object"

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

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

    "x-autobe-specification"?: string

    Settings

    Member Visibility

    On This Page

    Properties