docs: audit and improve public API surface (AGE-13)#69
Open
Larry-Osakwe wants to merge 1 commit intomainfrom
Open
docs: audit and improve public API surface (AGE-13)#69Larry-Osakwe wants to merge 1 commit intomainfrom
Larry-Osakwe wants to merge 1 commit intomainfrom
Conversation
Add consistent section organization ("=== Section ===") to all public API
__init__.py files across packages. Add module docstrings explaining:
- Local definitions vs re-exports
- Primary API vs Advanced API
- Exception categories (Configuration, Runtime, Validation)
Files updated:
- keycardai-oauth: Add section comments, mark base exception
- keycardai-mcp client: Add docstring, mark Session types as advanced
- keycardai-mcp server/auth: Add docstring with re-export guide
- keycardai-mcp-fastmcp: Add re-export guide, group exceptions by type
- keycardai-agents: Reorganize by usage pattern (Client/Server/Delegation)
Closes AGE-13
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
=== Section ===) to all public API__init__.pyfilesMissingContextErrorvsMissingAccessContextError)Files Updated
__init__.pyclient/__init__.pyserver/auth/__init__.py__init__.py__init__.pyAcceptance Criteria (AGE-13)
__init__.pyfiles reviewed for unintentional exports___all__lists_)Test plan
uv run pytest packages/oauth/tests- 102 passeduv run pytest packages/agents/tests- 69 passed, 1 skippeduv run pytest packages/mcp-fastmcp/tests- 49 passedCloses AGE-13