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

    Interface ICapabilitySchema

    Introspectable view of a registered capability.

    Returned by CapabilityRegistry.getSchema() and IIntrospectionAPI.getCapabilitySchema(). The loader field is intentionally absent — consumers only see the declaration metadata, not the loading implementation.

    interface ICapabilitySchema {
        id: string;
        label?: string;
        description?: string;
        gate?: ICapabilityConfigGate;
        configSchema?: Record<string, ICapabilityFieldSchema>;
        dependencies?: readonly string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    id label? description? gate? configSchema? dependencies?

    Properties

    id: string

    Unique capability identifier (kebab-case).

    label?: string

    Human-readable label (used by studio UI).

    description?: string

    Short description (shown in studio tooltip).

    gate?: ICapabilityConfigGate

    Config gate — how the capability is enabled/disabled by profile config.

    configSchema?: Record<string, ICapabilityFieldSchema>

    JSON Schema description of the config block consumed by this capability. Keys match the fields under the capability's config path. Used by studio/form-builder to generate config forms.

    dependencies?: readonly string[]

    IDs of other capabilities that must be enabled for this one to work.

    Settings

    Member Visibility

    On This Page

    Properties