docs: align all documentation with current SDK API surface#20
Merged
Conversation
Update documentation to reflect that hosted services (web apps, APIs, orchestrators) act as their own AP per spec §Self-Hosted Agents and self-issue agent tokens. AP enrollment is only needed for CLI tools, desktop apps, and mobile agents without a stable URL. - getting-started.md: add Self-Issued section before AP Bootstrap - agent-token-jwt.md: show both self-issued and AP-enrolled examples - overview.md: fix Requires column (JWKS host or self-hosted) - bootstrap-enrollment.md: scope to CLI/desktop agents - ps-asserted-access.md: lead with self-issued, AP in collapsible - concepts.md: agent token issued by 'Agent Provider or Self' - Orchestrator/README.md: remove dead AP config, update details
- README.md: three-party example now shows self-issued path (hosted services), not AP enrollment - docs/reference/dependency-injection.md: Key Principle section now explains both deployment models (hosted self-issue vs CLI/desktop AP enrollment) with separate Mermaid diagrams; add self-issued DI registration example alongside the AP-enrolled one - docs/README.md: scope BootstrapBuilder and AgentProviderClient descriptions to CLI/desktop agents
Validate code samples in 16 docs against the actual public API in src/AAuth/. Fix incorrect type names, property signatures, and patterns across server, signing-modes, workflows, reference, and advanced sections. Remove references to non-existent APIs and align DI option names with current source.
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
Comprehensive audit of all markdown documentation against the actual public API in
src/AAuth/. Ensures code samples compile against the current SDK and correctly reflect the self-issuance vs AP-enrollment distinction.Changes
Signing Modes
Workflows
interaction.UserUrl→interaction.UrlDelegateTokenRefresherwith properITokenRefresherimplDelegateTokenRefresherfixServer
ResourceSigningKey,ResourceKeyId,AllowedSignatureKeySchemes)AddAAuthAuthentication()registrationIAAuthKeyinterface typeReference
Advanced
FromJwk/ExportJwkto actual APISamples & Top-level
make demonoteValidation
src/AAuth/public type declarations