Skip to content

Conversation

@jo-arroyo
Copy link
Collaborator

@jo-arroyo jo-arroyo commented Nov 14, 2025

Moving docs to 1P

@jo-arroyo jo-arroyo marked this pull request as ready for review November 14, 2025 22:25
@jo-arroyo jo-arroyo requested a review from a team as a code owner November 14, 2025 22:25
Copilot AI review requested due to automatic review settings November 14, 2025 22:25
Copilot finished reviewing on behalf of jo-arroyo November 14, 2025 22:27
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 removes documentation references to the instance-aware flow feature from MSAL.js. The instance-aware flow allowed applications to indicate which cloud instance tokens were obtained from and which Microsoft Graph hosts they could be used with.

Key changes:

  • Removed the instance-aware documentation file entirely
  • Removed references to instance-aware documentation from the README and authority documentation

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
lib/msal-common/docs/authority.md Removed bullet point referencing instance-aware flow documentation
lib/msal-browser/docs/instance-aware.md Deleted entire documentation file describing instance-aware configuration and usage
lib/msal-browser/README.md Removed link to instance-aware documentation from the README
Comments suppressed due to low confidence (1)

lib/msal-browser/docs/instance-aware.md:1

  • This PR removes the instance-aware documentation file but does not remove the actual implementation code. The instanceAware configuration option and instance_aware query parameter are still implemented in:
  1. Configuration files:

    • lib/msal-browser/src/config/Configuration.ts (line 92, 258)
    • lib/msal-common/src/config/ClientConfiguration.ts (line 82, 92, 261)
  2. Implementation code:

    • lib/msal-browser/src/interaction_client/BaseInteractionClient.ts (lines 159-177)
    • lib/msal-common/src/client/AuthorizationCodeClient.ts (line 579-581)
    • lib/msal-common/src/protocol/Authorize.ts (lines 256-265)
  3. API surface:

    • lib/msal-browser/apiReview/msal-browser.api.md (line 287)
    • lib/msal-common/apiReview/msal-common.api.md (line 612)
  4. Tests:

    • Multiple test files in both msal-browser and msal-common

If the intent is to deprecate this feature, you should also:

  • Remove the implementation code
  • Remove the configuration options
  • Update the API review files
  • Remove or update related tests
  • Add deprecation notices if this is a phased removal
  • Create a migration guide if applications are using this feature

Additionally, lib/msal-browser/docs/configuration.md line 86 still documents the instanceAware configuration option and should be removed.

@jo-arroyo jo-arroyo merged commit 0c265e3 into msal-v5 Nov 20, 2025
12 checks passed
@jo-arroyo jo-arroyo deleted the instance-aware-docs branch November 20, 2025 00: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