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§
- Last
Export - One successful export remembered by the service session.
- Method
Access - Local-API policy for one IPC method.
- Status
- Aggregate state returned by
STATUS_PATH.
Enums§
- Server
Event - 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.