Repository navigation
fix: align Forward and Managed API contracts with current documentation - #40
Merged
Merged
Conversation
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
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
Align the existing Forward/Managed SDK contracts with the official QCA documentation reviewed on 2026-11-03. This adds typed Forward Session budgets and model overrides, approval evaluation details and Environment startup scripts; it fixes the language-specific gaps documented below. The README also documents startup timing, 64 KB / 5-minute constraints and failure events. No HTTP endpoints or version numbers change.
Forward event types now expose cumulative Credits and Outcome/status details, and shared model configuration exposes speed. Managed Memory version/redacted and Vault credentials are typed; Memory updated operations, list metadata, nested model types and legacy Thread usage are aligned where applicable.
Why
Current types omit fields in the documented API, and the approval result shape can be read incorrectly. This makes the existing endpoints usable through supported typed parameters and response fields.
Verification
Python 3.12:
uv run make lint,uv run make typecheck,uv run make test(4,340 passed, 73 live tests deselected),uv run make docs-check, changelog and release-tool tests passed. The follow-up commit changes only README documentation; the docs check was repeated successfully. Example CLI help commands were not rerun because no example CLI changed.Impact and migration
Use budget= directly on sync/async Forward Sessions. Omitted, None and object updates remain distinct. Legacy approval object parsing remains supported; Thread usage is now explicitly deprecated.
Budget/model omission and null semantics, cumulative usage consumption, and migration details are in CHANGELOG.md. A pre-1.0 minor release is required for the incompatible type changes.
Contract sources