openmixer — generated API reference
    Preparing search index...

    Interface RestOptionsBody

    A successful OPTIONS: the methods, and what each field can do ON THIS INSTANCE.

    interface RestOptionsBody {
        allow: readonly ResourceMethod[];
        carries?: string;
        demand?: true;
        fields: { readonly [field: string]: FieldCapability };
        id: ResourceId;
        index?: string;
        instances?: readonly Readonly<Record<string, string | number>>[];
        ok: true;
        path: string;
    }
    Index
    allow: readonly ResourceMethod[]
    carries?: string

    The per-instance row this COLLECTION carries as level series, and the field that indexes them — the collection's own declaration (carried-series.ts), so a generic client learns from the contract that declaring instances of carries is how it asks for this frame, and decodes each series field through the limit published beside it in fields. Both present on a carrying collection, both absent otherwise.

    demand?: true

    Present, and true, exactly when this row is PUMP-FED — the same fact the index publishes under demand, answered at the row's own address (demand gate §3d). Absent otherwise.

    fields: { readonly [field: string]: FieldCapability }
    index?: string
    instances?: readonly Readonly<Record<string, string | number>>[]

    Every id this entity currently has, when it can enumerate — the console ROSTER, asked at the layer that publishes declarations. Absent means "this entity cannot say", which a client must not read as "there are none".

    ok: true
    path: string