Setu-TS
    Preparing search index...

    Interface OpenApiSchemaObject

    OpenAPI 3.1 schema object.

    0.1.0

    interface OpenApiSchemaObject {
        $ref?: string;
        additionalProperties?: boolean | OpenApiSchemaObject;
        allOf?: readonly OpenApiSchemaObject[];
        anyOf?: readonly OpenApiSchemaObject[];
        const?: string | number | boolean;
        default?: unknown;
        enum?: readonly (string | number | boolean)[];
        exclusiveMaximum?: number;
        exclusiveMinimum?: number;
        format?: string;
        items?: OpenApiSchemaObject;
        maximum?: number;
        maxItems?: number;
        maxLength?: number;
        minimum?: number;
        minItems?: number;
        minLength?: number;
        properties?: Record<string, OpenApiSchemaObject>;
        required?: readonly string[];
        type?:
            | "string"
            | "number"
            | "boolean"
            | "object"
            | "null"
            | "array"
            | "integer";
    }
    Index
    $ref? additionalProperties? allOf? anyOf? const? default? enum? exclusiveMaximum? exclusiveMinimum? format? items? maximum? maxItems? maxLength? minimum? minItems? minLength? properties? required? type?
    $ref?: string

    Reference to a component schema.

    additionalProperties?: boolean | OpenApiSchemaObject

    For objects: additional properties schema.

    allOf?: readonly OpenApiSchemaObject[]

    AllOf for intersections.

    anyOf?: readonly OpenApiSchemaObject[]

    AnyOf for unions.

    const?: string | number | boolean

    Const value.

    default?: unknown

    Default value.

    enum?: readonly (string | number | boolean)[]

    Enum values.

    exclusiveMaximum?: number

    For numbers: exclusive maximum.

    exclusiveMinimum?: number

    For numbers: exclusive minimum.

    format?: string

    Format (e.g., 'email', 'uri', 'uuid', 'date-time').

    items?: OpenApiSchemaObject

    For arrays: schema of items.

    maximum?: number

    For numbers: maximum value.

    maxItems?: number

    For arrays: maximum items.

    maxLength?: number

    For strings: maximum length.

    minimum?: number

    For numbers: minimum value.

    minItems?: number

    For arrays: minimum items.

    minLength?: number

    For strings: minimum length.

    properties?: Record<string, OpenApiSchemaObject>

    For objects: properties map.

    required?: readonly string[]

    For objects: required property names.

    type?: "string" | "number" | "boolean" | "object" | "null" | "array" | "integer"

    Type of the value (string, number, integer, boolean, array, object, null).

    Settings
    Member Visibility

    On This Page
    Properties