openmixer — generated API reference
    Preparing search index...

    Interface RestPatchBody

    A successful PATCH: the state after the write, plus what reaching the audio actually did.

    projection is absent exactly when the patch changed nothing — an empty delta, the ordinary HTTP meaning of PATCH, which ResourceRegistry.patch answers without projecting so that an empty body can never reach a preamp. Absent therefore means "nothing was attempted", which is a different fact from { applied: false } ("attempted, and the desk refused"). Reporting the first as the second would invent a hardware refusal that never happened, and reporting it as { applied: true } would claim a write that never happened; both are the class of lie this layer exists to remove, so the field simply is not there.

    interface RestPatchBody {
        id: ResourceId;
        known?: readonly string[];
        ok: true;
        path: string;
        projection?: { applied: boolean; reason?: string; refusal?: Refusal };
        rev?: number;
        state: object;
    }

    Hierarchy (View Summary)

    Index
    id known? ok path projection? rev? state
    id: ResourceId
    known?: readonly string[]

    Which of state's own fields the entity actually KNOWS, vs a safe floor it is reporting because nobody has ever set or read it — absent when the entity draws no such distinction (the overwhelming majority; every field it reports is equally authoritative). Forwarded verbatim from ResourceRegistry; this router names no entity and invents nothing.

    ok: true
    path: string
    projection?: { applied: boolean; reason?: string; refusal?: Refusal }
    rev?: number

    The console revision AS OF this read (task #48) — the same stamp every stream event carries, off the one commit-seam counter, so a body from either door says how current it is in the same vocabulary. Absent on a console wired without the instrument.

    state: object

    Settings
    Member Visibility

    On This Page
    Properties