Skip to main content

Module local_api

Module local_api 

Source
Expand description

Shared wire contract for the opt-in local HTTP and WebSocket API.

The server and clients use these paths and payloads. The security and lifecycle decisions are recorded in ADR 0016.

Structs§

LastExport
One successful export remembered by the service session.
MethodAccess
Local-API policy for one IPC method.
Status
Aggregate state returned by STATUS_PATH.

Enums§

ServerEvent
Event sent as one text frame on EVENTS_PATH.

Constants§

API_VERSION
Local API protocol version.
CALL_PATH
Request dispatch endpoint.
DEFAULT_PORT
Default loopback TCP port.
EVENTS_PATH
WebSocket event endpoint.
STATUS_PATH
Aggregate status endpoint.
TOKEN_FILE
Token file name inside the application configuration directory.

Functions§

access
Returns the local-API policy for a wire method name.