featherbit UI
    Preparing search index...

    Interface VarEntry

    One row of the context-variable catalog served by GET /api/vars.

    Mirrors src/vars/catalog.rs::VarEntry field for field. kind: 'static' entries are fixed names (uri, status, ...); kind: 'family' entries are prefix_* patterns (http_*, arg_*, ...) whose members are only known once a trace is available, in which case family_source names the context collection (request_headers, query_params, ...) that supplies the live members.

    interface VarEntry {
        description: string;
        example: string;
        family_source?: string;
        kind: "static" | "family";
        name: string;
        path: string;
    }
    Index
    description example family_source? kind name path
    description: string

    One-line human-readable explanation.

    example: string

    Example $var usage shown in the UI.

    family_source?: string

    For families, the context collection that populates live members.

    kind: "static" | "family"

    Whether this is a single fixed name or a prefix_* family.

    name: string

    Variable name, e.g. uri, or a prefix_* pattern for families.

    path: string

    Universal-template namespace spelling (e.g. request.method), or "" when this entry has no direct {{...}} equivalent (e.g. protocol, query_string, post_arg_*) — those remain legacy-$-only and are skipped when building path-keyed suggestions.

    Settings
    Member Visibility

    On This Page
    Properties