-
Notifications
You must be signed in to change notification settings - Fork 0
Declare the streaming endpoints in the contract #53
Copy link
Copy link
Open
Labels
area: agentsAgent runtime, agent APIs, tools, prompts, or UI.Agent runtime, agent APIs, tools, prompts, or UI.component: apiHTTP API, OpenAPI contract, or API client concern.HTTP API, OpenAPI contract, or API client concern.priority: P2Medium; normal planned work.Medium; normal planned work.type: featureNew user-facing or operator-facing capability.New user-facing or operator-facing capability.
Description
Activity
Metadata
Metadata
Assignees
Labels
area: agentsAgent runtime, agent APIs, tools, prompts, or UI.Agent runtime, agent APIs, tools, prompts, or UI.component: apiHTTP API, OpenAPI contract, or API client concern.HTTP API, OpenAPI contract, or API client concern.priority: P2Medium; normal planned work.Medium; normal planned work.type: featureNew user-facing or operator-facing capability.New user-facing or operator-facing capability.
What to build
The four real-time endpoints this service exposes appear in its contract.
Three of them are HTTP and can be declared directly as event-stream responses: the session event feed, the workspace runner event feed, and the chat answer stream. The fourth is a WebSocket used for terminal attach, which OpenAPI cannot express — document it where the service's contract documentation lives, so it stops being invisible.
These endpoints are in production and consumed by the agents UI today, and nothing currently detects a change to their event shapes. Declaring them buys documentation and breaking-change coverage; it does not make them fuzzable.
Acceptance criteria
Blocked by