GeoLeaf Core API - v3.0.0
    Preparing search index...

    Interface ICapabilityFieldSchema

    JSON Schema subset describing a single configuration field.

    Used by capability declarations to expose their config shape to studio / form-builder plugins (Phase 4). Intentionally minimal — only the subset needed to generate a UI form.

    interface ICapabilityFieldSchema {
        type: "string" | "number" | "boolean" | "object" | "array";
        description?: string;
        default?: unknown;
        enum?: unknown[];
        minimum?: number;
        maximum?: number;
        properties?: Record<string, ICapabilityFieldSchema>;
        items?: ICapabilityFieldSchema;
    }
    Index

    Properties

    type description? default? enum? minimum? maximum? properties? items?

    Properties

    type: "string" | "number" | "boolean" | "object" | "array"

    JSON primitive or structural type.

    description?: string

    Human-readable description of this field (shown in studio).

    default?: unknown

    Default value when the field is absent from config.

    enum?: unknown[]

    Allowed values — renders as a select/radio in studio.

    minimum?: number

    Minimum numeric value (type: "number" only).

    maximum?: number

    Maximum numeric value (type: "number" only).

    properties?: Record<string, ICapabilityFieldSchema>

    Nested field schemas (type: "object" only).

    items?: ICapabilityFieldSchema

    Schema for array items (type: "array" only).

    Settings

    Member Visibility

    On This Page

    Properties