Skip to content

Conversation

@jo-arroyo
Copy link
Collaborator

@jo-arroyo jo-arroyo commented Jan 7, 2026

This PR updates our comments for various requests as this helps our typedoc documentation.

@jo-arroyo jo-arroyo marked this pull request as ready for review January 7, 2026 21:58
@jo-arroyo jo-arroyo requested review from a team as code owners January 7, 2026 21:58
Copilot AI review requested due to automatic review settings January 7, 2026 21:58
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR enhances the TypeDoc documentation across the MSAL.js library by adding missing parameter descriptions and improving existing documentation comments for various request types. The changes ensure that all public API parameters are properly documented for better developer experience and API documentation generation.

Key Changes

  • Added documentation for previously undocumented parameters (e.g., redirectUri, refreshTokenExpirationOffsetSeconds, earJwk, platformBroker, account, timeout, ccsCredential, clientInfo, maxAge)
  • Improved formatting and consistency of existing parameter descriptions
  • Fixed spelling errors (e.g., "acqusition" → "acquisition", "enableSpaAuthCode" → "enableSpaAuthorizationCode")

Reviewed changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
lib/msal-node/src/request/SilentFlowRequest.ts Added documentation for redirectUri and refreshTokenExpirationOffsetSeconds parameters
lib/msal-node/src/request/DeviceCodeRequest.ts Added documentation for timeout parameter
lib/msal-node/src/request/CommonDeviceCodeRequest.ts Improved formatting for extraQueryParameters and extraParameters descriptions
lib/msal-node/src/request/CommonClientCredentialRequest.ts Cleaned up documentation, removed deprecated parameter reference, improved formatting
lib/msal-node/src/request/AuthorizationUrlRequest.ts Added documentation for earJwk and platformBroker parameters
lib/msal-common/src/request/CommonSilentFlowRequest.ts Added documentation for redirectUri and refreshTokenExpirationOffsetSeconds parameters
lib/msal-common/src/request/CommonRefreshTokenRequest.ts Added documentation for ccsCredential and redirectUri parameters
lib/msal-common/src/request/CommonAuthorizationUrlRequest.ts Added documentation for earJwk and platformBroker parameters
lib/msal-common/src/request/CommonAuthorizationCodeRequest.ts Fixed typo, added documentation for clientInfo and ccsCredential, improved formatting for existing parameters
lib/msal-common/src/request/BaseAuthRequest.ts Added documentation for maxAge, improved formatting for httpMethod and extraParameters
lib/msal-browser/src/request/SsoSilentRequest.ts Added documentation for account parameter
lib/msal-browser/src/request/SilentRequest.ts Added documentation for state parameter
lib/msal-browser/src/request/RedirectRequest.ts Added documentation for account parameter
lib/msal-browser/src/request/AuthorizationCodeRequest.ts Added comprehensive documentation block for the entire request type
lib/msal-browser/apiReview/msal-browser.api.md Updated API review file to reflect proper documentation tag for AuthorizationCodeRequest
change/@azure-msal-node-ab1aea4a-e097-4a30-b835-20e7f6e88725.json Beachball change file for msal-node package
change/@azure-msal-common-f13438e9-1b16-4fcf-a97c-5a48e5e6887b.json Beachball change file for msal-common package
change/@azure-msal-browser-c77a5d91-8026-4a7c-9a4d-7c07f66d8208.json Beachball change file for msal-browser package

@jo-arroyo jo-arroyo merged commit 6a1c1de into msal-v5 Jan 9, 2026
7 checks passed
@jo-arroyo jo-arroyo deleted the request-typedocs-update branch January 9, 2026 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants