Skip to main content

Module http

Module http 

Source

Structs§

Capabilities
GET /agdx/capabilities reply: what the /agdx/* surface offers on this server, so a browser client can feature-detect before showing the projections / query / KV / fork views. Richer than the binary AGDX_HELLO probe (per-surface flags plus the wire op versions the JSON bodies must match), and it answers truthfully even when the managed backend is disabled (200 with managed: false).
CasCommittedView
PUT /agdx/kv/{namespace}/{key}/cas reply on success: the new version the committed write took.
ClientMetadataListView
One page of the GET /agdx/clients discovery read. next_cursor is the after query parameter for the next page, or None on the last page.
ClientMetadataView
One connection on the GET /agdx/clients discovery surface. metadata is URL-safe unpadded base64 of the opaque advertised bytes (a JSON string cannot carry raw bytes), or None when the connection advertised none. The console decodes and interprets it per producer kind (an agent card or an app blob).
ClientsQuery
GET /agdx/clients query parameters: the discovery filters and the page window, all optional. Shared by the server handler and the typed client so the query string cannot drift between them.
DecodeRecordBody
POST /agdx/schemas/{id}/decode body: the record payload as URL-safe unpadded base64.
DeletedManyView
DELETE /agdx/kv/{namespace} reply: the number of entries removed.
ErrorBody
The canonical error body every /agdx/* route returns on a non-2xx status. The HTTP binding’s rule is “a 2xx carries the bare Ok payload, a failure carries this”: the status line gives the coarse class (from ResultCode::http_status) and this body gives the machine-dispatchable ResultCode plus a human message, so a client matches on code instead of grepping the message text (which is for humans and may change). detail carries optional structured context (e.g. the conflicting version on a CAS miss) as free-form JSON.
ForkCreateBody
POST /agdx/forks body.
ForkPutBody
PUT /agdx/forks/{id}/rows body. payload_b64 is URL-safe unpadded base64, like every binary body on this surface.
GraphEdgeView
One graph edge on the HTTP surface: endpoint ids as strings, the type, and the weight.
GraphNeighborsQuery
GET /agdx/graph/{name}/neighbors/{node} query: the traversal direction (out, in, or both, omitted for the default out), an optional edge-type filter, the hop depth (omitted for the default one hop), and a result limit (omitted for the backend ceiling). One struct shared by the typed client and the server route, so the two cannot drift.
GraphNodeView
One graph node on the HTTP surface: id as a string, its labels, and its attributes rendered as strings (e.g. the entity value) for a browser or wasm client that has no access to the typed Value.
GraphResultView
POST /agdx/graph/{name}/query reply: the reachable nodes, traversed edges, and (for a paths return) the reconstructed paths as id sequences.
KvCapsView
The managed key-value surface on the HTTP capabilities reply.
KvCasQuery
PUT /agdx/kv/{namespace}/{key}/cas query: the compare-and-swap precondition plus an optional expiry. Exactly one of expect_version (match the held version) or expect_absent (create-if-absent) is set, mirroring the binary CasExpect. The value rides the raw request body.
KvEntryView
One KV entry on the HTTP surface. key and value are URL-safe unpadded base64, because keys and values are arbitrary bytes that JSON strings cannot carry raw.
KvPageView
One KV scan page on the HTTP surface.
KvPutQuery
PUT /agdx/kv/{namespace}/{key} query: an optional absolute expiry.
KvScanQuery
GET /agdx/kv/{namespace} scan filters. The byte-valued bounds (prefix/start/end/key_contains) are base64url, like every binary value on this surface.
PathView
One path in a GraphResultView: parallel node and edge id sequences, ids as Crockford-base32 strings (the JSON view of crate::graph::Path).
ProjectionListQuery
GET /agdx/projections filters. Every field is optional, and an absent field is omitted from the query string (no empty topic=). Field names are the PARAM_* consts verbatim, so the client serializer and the server parser share one spelling.
PromotedView
POST /agdx/forks/{id}/promote reply: the number of rows applied.
QueryCapsView
The managed query surface on the HTTP capabilities reply: whether it is served, its registry browse views, and the consistency it honors.
RegisterSchemaBody
POST /agdx/schemas body: the register request without an id. The managed backend allocates it and the reply carries it back as {"SchemaRegistered":id}.
RemoveBindingBody
DELETE /agdx/bindings body: which binding to remove, by its source stream and topic. projection_ref absent removes the whole binding for that source. projection_ref present removes only that one projection from the binding, leaving the rest. Mirrors ControlCommand::RemoveBinding.
RunPageView
One page of runs on the HTTP surface: the rows (the binary AgentRunInfo is already JSON-safe) plus the next-page cursor as URL-safe unpadded base64, like every binary value on this surface. Absent cursor means the last page.
RunsQuery
GET /agdx/runs filters: the binary AgentList rendered as query parameters. state is the snake-case AgentRunState word, cursor is the base64url form of the opaque page cursor, like every binary value on this surface. One struct shared by the typed client and the server route, so the two cannot drift.
SchemaListQuery
GET /agdx/schemas filters. name_contains is the substring filter on a schema’s optional name, the same spelling as the projection list, so the two list surfaces share one filter vocabulary.

Constants§

AUTHZ_ROLES_PATH
GET /agdx/authz/roles: list governance roles.
AUTHZ_WHOAMI_PATH
GET /agdx/authz/whoami: the caller’s effective governance roles and grants.
BINDINGS_PATH
POST /agdx/bindings to apply, DELETE to remove.
CAPABILITIES_PATH
GET /agdx/capabilities: the feature-detection probe.
CLIENTS_PATH
GET /agdx/clients to list live connections with their advertised metadata, filtered and paginated by query parameters. The HTTP face of the AGDX_GET_CLIENTS_METADATA discovery read.
FORKS_PATH
GET /agdx/forks to list, POST to create.
GRAPHS_PATH
GET /agdx/graphs to list graph projections, POST to register.
KV_EXPIRES_AT_MICROS_HEADER
Response header on GET /agdx/kv/{namespace}/{key} carrying the entry’s absolute expiry (epoch microseconds) as a decimal string. The value itself rides the raw response body, so this header carries the one piece of out-of-band metadata a single-key read needs. Owned here so the name is a wire constant rather than an unscoped string. Absent means no expiry.
KV_PATH
GET /agdx/kv to list the caller’s namespaces.
PARAM_CURSOR
?cursor=: opaque continuation token from the prior page.
PARAM_END
?end= on a KV scan: base64url exclusive upper bound.
PARAM_EXPECT_ABSENT
?expect_absent= on a KV compare-and-swap: apply only if the key is absent (create-if-absent).
PARAM_EXPECT_VERSION
?expect_version= on a KV compare-and-swap: apply only if the key holds this exact version.
PARAM_EXPIRES_AT_MICROS
?expires_at_micros= on a KV PUT: absolute expiry, epoch microseconds.
PARAM_ID_PREFIX
?id_prefix= on GET /agdx/projections: keep ids starting with the prefix.
PARAM_KEY_CONTAINS
?key_contains=: base64url substring the key must contain.
PARAM_LIMIT
?limit=: page size.
PARAM_NAME_CONTAINS
?name_contains= on a projection or schema list: substring over the name.
PARAM_PREFIX
?prefix= on a KV scan: base64url key prefix.
PARAM_SEARCH
?search= on GET /agdx/projections: one substring matched against the projection name OR id. A console with a single filter box maps to it. A server matches it as name_contains(name) OR id contains search. Composes (AND) with the narrower name_contains / id_prefix when several are set.
PARAM_START
?start= on a KV scan: base64url inclusive lower bound.
PARAM_TOPIC
?topic= on GET /agdx/projections: filter to bindings off this source topic.
PROJECTIONS_PATH
GET /agdx/projections to list, POST to register.
QUERY_PATH
POST /agdx/query (and GET with the query as a parameter).
RUNS_PATH
GET /agdx/runs to list runs (filtered and paged, RunsQuery), POST to submit one (a JSON AgentSubmit body). The HTTP face of the AGDX_AGENT_* run-registry band.
SCHEMAS_PATH
GET /agdx/schemas to list, POST to register.

Functions§

authz_role_path
GET/PUT/DELETE /agdx/authz/roles/{name}.
authz_user_roles_path
GET/PUT /agdx/authz/users/{id}/roles: read or replace one user’s role set.
fork_path
DELETE /agdx/forks/{id}.
fork_promote_path
POST /agdx/forks/{id}/promote.
fork_rows_path
PUT /agdx/forks/{id}/rows.
graph_neighbors_path
GET /agdx/graph/{name}/neighbors/{node}: one-hop neighbor read.
graph_path
DELETE/GET /agdx/graphs/{id}: drop or read a graph projection.
graph_query_path
POST /agdx/graph/{name}/query: run a traversal (a GraphQuery body).
kv_cas_path
PUT /agdx/kv/{namespace}/{key}/cas: a conditional write (compare-and-swap). The precondition rides the query string (expect_version or expect_absent) and the value rides the raw body, like the plain PUT. A success replies CasCommittedView with the new version, a precondition miss replies 409 with an ErrorBody of code conflict whose detail carries the current version.
kv_entry_path
GET/PUT/DELETE /agdx/kv/{namespace}/{key}. key is the URL-safe unpadded base64 form of the key bytes, the encoding this surface uses for every binary body.
kv_namespace_path
GET /agdx/kv/{namespace} to scan, DELETE to bulk-delete.
projection_path
GET/DELETE /agdx/projections/{id}.
run_cancel_path
POST /agdx/runs/{id}/cancel: record the cancel intent on a run.
run_path
GET /agdx/runs/{id}: read one run’s status.
schema_decode_path
POST /agdx/schemas/{id}/decode.
schema_path
GET/DELETE /agdx/schemas/{id}.