Add XML docs for ATM public API - #359
Merged
Merged
Conversation
Add XML documentation across public ATM and ATM.OpenIdConnect types and members, including DPoP concept clarifications and IClientCredentialsTokenManager docs. Re-enable CS1591 enforcement for ATM src by removing the inherited suppression in access-token-management/src/Directory.Build.props. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds/updates XML documentation across the Access Token Management public API surface (core + OpenIdConnect + DPoP + OTel) and removes the inherited CS1591 suppression for the ATM src projects so missing public XML docs are enforced again.
Changes:
- Added/expanded XML docs for public types/members across token result APIs, strongly-typed value wrappers, DPoP APIs, and OpenTelemetry helpers.
- Clarified DPoP documentation to better describe how proof keys, proof requests, proofs, nonces, and thumbprints relate.
- Re-enabled CS1591 for ATM
srcprojects by strippingCS1591from the inheritedNoWarnlist.
Reviewed changes
Copilot reviewed 36 out of 36 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| access-token-management/src/Directory.Build.props | Removes inherited CS1591 suppression to enforce public XML docs. |
| access-token-management/src/AccessTokenManagement/TokenResultExtensions.cs | Adds type-level XML docs for token result extension methods. |
| access-token-management/src/AccessTokenManagement/TokenResult.cs | Adds/expands docs for token result types and members. |
| access-token-management/src/AccessTokenManagement/ServiceCollectionExtensions.cs | Documents default resiliency pipeline extension. |
| access-token-management/src/AccessTokenManagement/Scope.cs | Documents Scope value type and key members/constants. |
| access-token-management/src/AccessTokenManagement/Scheme.cs | Documents Scheme value type, constants, and members. |
| access-token-management/src/AccessTokenManagement/Resource.cs | Documents Resource value type and key members/constants. |
| access-token-management/src/AccessTokenManagement/RefreshToken.cs | Documents RefreshToken value type and key members/constants. |
| access-token-management/src/AccessTokenManagement/OTel/ActivitySources.cs | Documents activity sources/names emitted by instrumentation. |
| access-token-management/src/AccessTokenManagement/OTel/AccessTokenManagementMetrics.cs | Documents metrics publisher, meter name, enum values, and methods. |
| access-token-management/src/AccessTokenManagement/IdentityToken.cs | Documents IdentityToken value type and key members/constants. |
| access-token-management/src/AccessTokenManagement/IClientCredentialsTokenManager.cs | Documents primary client-credentials token manager API. |
| access-token-management/src/AccessTokenManagement/HybridCacheConstants.cs | Adds XML docs for cache tag constants container. |
| access-token-management/src/AccessTokenManagement/HttpRequestContext.cs | Documents request context fields used for HTTP request metadata. |
| access-token-management/src/AccessTokenManagement/ForceTokenRenewal.cs | Documents force-renewal flag value type. |
| access-token-management/src/AccessTokenManagement/FailedResult.cs | Documents protocol failure result type and formatting behavior. |
| access-token-management/src/AccessTokenManagement/DPoP/IDPoPProofService.cs | Clarifies DPoP proof creation/thumbprint responsibilities via docs. |
| access-token-management/src/AccessTokenManagement/DPoP/IDPoPNonceStoreKeyGenerator.cs | Clarifies nonce cache key generation semantics via docs. |
| access-token-management/src/AccessTokenManagement/DPoP/IDPoPNonceStore.cs | Clarifies nonce store behavior and async contract via docs. |
| access-token-management/src/AccessTokenManagement/DPoP/DPoPProofThumbPrint.cs | Improves docs for thumbprint value type and parsing/helpers. |
| access-token-management/src/AccessTokenManagement/DPoP/DPoPProofRequest.cs | Clarifies proof request parameters and meanings via docs. |
| access-token-management/src/AccessTokenManagement/DPoP/DPoPProofKey.cs | Adds high-level docs for proof key and related members. |
| access-token-management/src/AccessTokenManagement/DPoP/DPoPProof.cs | Clarifies proof JWT meaning and lifecycle via docs/remarks. |
| access-token-management/src/AccessTokenManagement/DPoP/DPoPNonceContext.cs | Clarifies nonce context identity (method + URL) via docs. |
| access-token-management/src/AccessTokenManagement/DPoP/DPoPNonce.cs | Adds docs for nonce parsing, defaults, and members. |
| access-token-management/src/AccessTokenManagement/DPoP/DPoPExtensions.cs | Documents HttpRequestMessage option extension methods for DPoP. |
| access-token-management/src/AccessTokenManagement/ClientSecret.cs | Documents ClientSecret value type and key members. |
| access-token-management/src/AccessTokenManagement/ClientId.cs | Documents ClientId value type, parsing helpers, and members. |
| access-token-management/src/AccessTokenManagement/ClientCredentialsTokenManagementBuilder.cs | Documents builder surface for configuring client-credentials clients. |
| access-token-management/src/AccessTokenManagement/ClientCredentialsClientName.cs | Documents client name value wrapper behavior. |
| access-token-management/src/AccessTokenManagement/ClientCredentialsCacheKey.cs | Documents cache key wrapper and max length constant. |
| access-token-management/src/AccessTokenManagement/AccessTokenRequestHandler.cs | Adds inheritdoc/member docs for handler and nested token interface. |
| access-token-management/src/AccessTokenManagement/AccessToken.cs | Documents access token wrapper and max length constant. |
| access-token-management/src/AccessTokenManagement.OpenIdConnect/UserToken.cs | Documents DPoP-related property on user token model. |
| access-token-management/src/AccessTokenManagement.OpenIdConnect/TokenForParameters.cs | Documents NoRefreshToken behavior and invariants. |
| access-token-management/src/AccessTokenManagement.OpenIdConnect/OpenIdConnectTokenManagementDefaults.cs | Documents scheme-to-client-name helper used internally. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
StuFrankish
previously approved these changes
Aug 13, 2026
Fix malformed XML doc block in DPoPProofKey ctor docs, tighten CS1591 removal to ';CS1591' in ATM Directory.Build.props, and align UserToken DPoPJsonWebKey docs with JWK terminology. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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