[AAASM-4874] 📝 (docs): Document canonical AA_* env vars#281
Merged
Conversation
Document AA_GATEWAY_URL / AA_API_KEY as the canonical resolver env vars (gateway_resolver.py:53-54), keeping AAASM_* only as a deprecated alias that now emits a DeprecationWarning. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The resolver reads AA_GATEWAY_URL / AA_API_KEY; the AASM_* name in this paragraph exists nowhere in the code. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
Review — Claude CodeCI: ✅ green (all checks SUCCESS + expected SKIPPED; no failures). |
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.
Description
python-sdk docs documented only the deprecated
AAASM_GATEWAY_URL/AAASM_API_KEYenv vars as if they were current, never the canonicalAA_GATEWAY_URL/AA_API_KEYnames the resolver actually reads first. One doc also had a typo namingAASM_*(missing an "A"), a variable that exists nowhere in the codebase.Verified against
agent_assembly/core/gateway_resolver.py: canonical vars areAA_GATEWAY_URL/AA_API_KEY(lines 53-54);AAASM_*is accepted only as a deprecated fallback that emits aDeprecationWarning(lines 58-59,_resolve_envat 91-113). Users following the old docs got warned at every SDK startup.Changes (docs-only):
configuration.md— resolution-order list and theexportexample now lead withAA_*;AAASM_*kept as a labeled deprecated alias.troubleshooting.md— error-table and "can't reach the gateway" hints useAA_*(alias noted).examples/preparing-the-runtime-environment.md— fixed theAASM_*typo toAA_*.Type of Change
Breaking Changes
Related Issues
Closes AAASM-4874
Testing
Doc-only change; no runtime code touched. Confirmed the docs now name the same env vars the resolver reads (
AA_GATEWAY_URL/AA_API_KEY), and grep shows no remainingAASM_*typo. Note: docs-only PRs run no CI in this repo (ci.yamlpath allow-list excludesdocs/**).Checklist