Fix stack 13: correct doc drift + add API stability policy#37
Merged
Conversation
ebarti
force-pushed
the
review-fixes/12-packaging-ci
branch
from
72f6288 to
fe2d61a
Compare
ebarti
force-pushed
the
review-fixes/13-docs-policy
branch
from
1e865fb to
9a106ca
Compare
ebarti
force-pushed
the
review-fixes/12-packaging-ci
branch
from
fe2d61a to
0ff966a
Compare
ebarti
force-pushed
the
review-fixes/13-docs-policy
branch
2 times, most recently
from
22b065c to
e1fcdb3
Compare
ebarti
force-pushed
the
review-fixes/12-packaging-ci
branch
from
6cc291c to
516a45f
Compare
ebarti
force-pushed
the
review-fixes/13-docs-policy
branch
from
e1fcdb3 to
162349f
Compare
…ty policy - capability-matrix credential-diagnostics row implied Claude/Codex report missing-credential diagnostics; only Antigravity does. Clarified (Claude/Codex report available with an auth_source label and defer auth to run()). Also fixed the streaming/tool-event rows (Codex now emits tool events; vendor.turn is Antigravity-only) to match the adapters. - providers.md Antigravity policy table claimed a READ_ONLY filesystem drops the allow_all policy; the code drops it only for STRICT. Corrected, and documented the READ_ONLY + explicit allowed_tools rejection. - README advertised AgentResult.artifacts as a returned value; it is never populated. Marked reserved (always empty today). Documented the new first-class model/reasoning_effort fields and FinishReason. - providers.md now documents system-prompt mapping across all three adapters and Claude's READ_ONLY -> plan mapping + metadata['permission_mode']. - Add docs/api-stability.md (public surface, 0.x policy, vendor pin policy, deprecation) and ship it in the sdist. Refs REVIEW.md docs findings, §5 policy.
…ead-only dicts wording
…emantics; round-2 CHANGELOG - Scope the mapping-immutability claims to the top level everywhere they are made (CHANGELOG, api-stability): the freeze is shallow and nested containers stay mutable, which the test suite now pins. - providers.md no longer claims all three adapters map reasoning_effort: Claude/Codex map it to effort=, Antigravity rejects it with a typed error; effort vocabularies are vendor-defined pass-throughs. - Document the per-mode subtractive deny-list semantics and the STRICT allow-list rejection in the capability matrix, and add a reasoning_effort row to the rejected-inputs table. - CHANGELOG entries for the round-2 fixes: codex unknown-status fail-closed, codex cached-token accounting, smashed-case redaction, claude budget fail-closed, reasoning_effort wiring + kw_only fields.
ebarti
force-pushed
the
review-fixes/12-packaging-ci
branch
from
516a45f to
099a00e
Compare
ebarti
force-pushed
the
review-fixes/13-docs-policy
branch
from
162349f to
7c28b8a
Compare
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.
Stacked review-fix PR 13/N (base:
review-fixes/12-packaging-ci).REVIEW.md docs findings + §5 policy:
auth_sourcelabel; auth failures surface atrun()). Streaming/tool-event rows updated to match the adapters (Codex now emits tool events;vendor.turnis Antigravity-only).READ_ONLYfilesystem drops theallow_allpolicy; the code drops it only forSTRICT. Corrected, plus theREAD_ONLY+ explicitallowed_toolsrejection.artifactswas advertised as returned but is never populated — marked reserved (empty today). Documented the new first-classmodel/reasoning_effortfields andFinishReason.READ_ONLY→plan +metadata["permission_mode"].docs/api-stability.md(public surface, 0.x policy, vendor-pin policy, deprecation), shipped in the sdist.Docs-only + sdist include. Suite 177 passed / 12 skipped.
Re-review amendments.
docs/api-stability.mdnow states what the capped weekly canary can and cannot catch (a release above a cap is invisible until the cap is raised) and describes the read-only mappings accurately (dict subclass — asdict/pickle/deepcopy/JSON keep working).Round 2 (re-review follow-up)
docs/api-stability.md.docs/providers.mdno longer claims all three adapters mapreasoning_effort: Claude/Codex map it toeffort=, Antigravity rejects it; effort vocabularies are vendor-defined pass-throughs.reasoning_effortrow.