@tikoci/centrs
    Preparing search index...

    Interface ProtocolApiRequest

    A normalized api request the orchestrator hands to a transport. It is transport-agnostic: the REST adapter maps the verb to an HTTP method + URL (id-in-path, .query/.proplist body), the native adapter maps it to a tagged talk (=.id=, ?-prefixed queries, =.proplist=). The orchestrator owns method→verb, validation, and the write gate; the adapter only executes.

    interface ProtocolApiRequest {
        attributes?: Record<string, string>;
        id?: string;
        path: string;
        proplist?: readonly string[];
        query?: readonly string[];
        script?: string;
        verb: ApiVerb;
    }
    Index

    Properties

    attributes? id? path proplist? query? script? verb

    Properties

    attributes?: Record<string, string>

    Body fields (string values), the JSON object for add/set or the args for a run command.

    id?: string

    Object id (*1) for get-one/set/remove — REST puts it in the URL, native in =.id=.

    path: string

    Slash path without id, e.g. /ip/address. For run, the command target (/interface/monitor-traffic); ignored when script is set.

    proplist?: readonly string[]

    Property projection → REST .proplist / native =.proplist=.

    query?: readonly string[]

    Row filter in REST .query form (no leading ?), e.g. ["type=ether", "#!"]; native prefixes each with ?.

    script?: string

    Raw console line for the /execute script form (run); when set, path/attributes are ignored.

    verb: ApiVerb

    Settings

    Member Visibility

    On This Page

    Properties