docs: fix README/docstring transport-error claims#77
Open
amavashev wants to merge 3 commits into
Open
Conversation
… aggregate health Aggregate /actuator/health requires X-Admin-API-Key since cycles-server v0.1.25.45 and fails closed with 500 when the server has no admin key configured — this assertion has been the visible failure in the org nightly Full-Stack Integration since 2026-06-28. The liveness/readiness probes are the public, Redis-aware health contract a credential-less client can rely on; the health-check test now probes /actuator/health/readiness. Integration-test-only; no library code change, no version bump. AUDIT.md updated. Companion PRs: runcycles/.github (workflow readiness polling + event-server management port) and the sibling client repo.
README documented CyclesTransportError as raised on network failure; nothing in the package raises it. Rewrote the exception-table row and added a Transport errors subsection describing actual behavior: the decorator raises CyclesProtocolError with status == -1 (error_code None) at reserve time; the programmatic client returns CyclesResponse with is_transport_error / status -1. The class remains exported for user code. AUDIT.md updated (repo convention: no CHANGELOG entry for doc-only changes). Surfaced by the cycles-docs integration audit (runcycles/cycles-docs#785).
Apply 4 / modify 0 / skip 0: - README CyclesProtocolError row now covers SDK-wrapped reserve-time transport failures (status == -1) - transport-errors bullet broadened to lifecycle-managed surfaces (@cycles and stream_reservation()) - CyclesTransportError docstring no longer claims it is raised; documents the actual status == -1 surfacing - AUDIT.md rolling date line updated to 2026-07-09
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README documented
CyclesTransportErroras raised on network failure; nothing in the package raises it. Transport failures actually surface asCyclesProtocolErrorwithstatus == -1(lifecycle-managed surfaces:@cyclesandstream_reservation()) orCyclesResponse.transport_error(programmatic). Rewrote the exception table row, added a Transport errors subsection, fixed theCyclesTransportErrordocstring to stop claiming it is raised, and updated AUDIT.md (repo convention: no CHANGELOG entry for doc-only changes).Follow-up question for maintainers (out of scope here): should a future minor actually raise
CyclesTransportErroron transport failures — the class exists and is exported — or should it be deprecated? Both clients (Python and TypeScript) share this exported-but-never-raised state.Codex-reviewed (REVISE-MINOR → applied). Surfaced by runcycles/cycles-docs#785; matches the docs-site wording fixed there.
Test plan
exceptions.pyAST-parses