Skip to content

Commit e1f9523

Browse files
committed
docs(craft): state the packet rollout and daemon error contracts
Clients ignore unknown packet types by design, so the artifact packet ships before its consumer, and the sandbox daemon cannot import onyx.* so its routes raise HTTPException rather than OnyxError. Both were review questions twice over, the code now answers them itself.
1 parent 6efaa0f commit e1f9523

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

backend/onyx/server/features/build/packets.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@ class ArtifactPacket(BasePacket):
9696
Carries the full row, unlike the ids-only approval packet, so a consumer
9797
can render a card with no round trip. The version is pinned at announce
9898
time and the index refetch at turn end is the completeness guarantee.
99+
No shipped client parses this type yet: clients ignore unknown packet
100+
types by design, and the consumer lands with the output panel frontend.
99101
"""
100102

101103
type: Literal["artifact"] = "artifact"

backend/onyx/server/features/build/sandbox/image/sandbox_daemon/server.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
"""Sandbox daemon HTTP server.
2+
3+
Runs standalone inside the sandbox container with only stdlib, fastapi, and
4+
pydantic available. ``onyx.*`` is unimportable here, so routes raise
5+
``HTTPException`` directly instead of the api-server's ``OnyxError`` contract,
6+
and the api-server's SidecarClient translates failures for its callers.
7+
"""
8+
19
import asyncio
210
import base64
311
import binascii

0 commit comments

Comments
 (0)