Skip to content

docs: add deprecation notice for UsersAPIClient in Management API example#990

Open
utkrishtsahu wants to merge 2 commits into
mainfrom
docs/sync-2026-06-25
Open

docs: add deprecation notice for UsersAPIClient in Management API example#990
utkrishtsahu wants to merge 2 commits into
mainfrom
docs/sync-2026-06-25

Conversation

@utkrishtsahu

@utkrishtsahu utkrishtsahu commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Automated documentation drift fix. 1 finding addressed (0 P1 · 1 P2 · 0 P3).

UsersAPIClient is marked @Deprecated in source (auth0/src/main/java/com/auth0/android/management/UsersAPIClient.kt) — "will be removed in the next major version of the SDK" — but the Management API section in EXAMPLES.md uses it without any deprecation callout. Users copy-pasting the example get a deprecation warning with no migration pointer.

Changes

  • EXAMPLES.md — added a deprecation notice above the UsersAPIClient example in the Management API section (P2-A). The example itself is left intact, since users on the current major still rely on it.
Full Drift Report — Auth0.Android (3.19.0)
# Severity File Issue
1 P2 EXAMPLES.md UsersAPIClient used in Management API example without a deprecation notice; class is @Deprecated in source

Verified as not drift: loginWithOTP already has a deprecation note in docs; passkey examples (signupWithPasskey/signinWithPasskey/passkeyChallenge) match current source; README install pin matches latest release 3.19.0.


🤖 Generated with syncing-sdk-docs skill

Summary by CodeRabbit

  • Documentation
    • Added deprecation callouts to clarify that legacy MFA login methods are deprecated and will be removed in the next major version, with guidance to use the recommended MFA API client.
    • Added a deprecation notice for the management API client that will be removed in the next major version.

@utkrishtsahu utkrishtsahu requested a review from a team as a code owner June 25, 2026 06:57
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f31499f8-5083-43b9-9595-d853d5d94d6b

📥 Commits

Reviewing files that changed from the base of the PR and between 7927fce and 413a957.

📒 Files selected for processing (1)
  • EXAMPLES.md
✅ Files skipped from review due to trivial changes (1)
  • EXAMPLES.md

📝 Walkthrough

Walkthrough

Added deprecation callouts in EXAMPLES.md for legacy MFA methods and UsersAPIClient, and removed the older generic MFA deprecation note.

Changes

API deprecation documentation

Layer / File(s) Summary
MFA deprecation callout
EXAMPLES.md
Adds a warning for deprecated MFA login methods, points to MfaApiClient, and removes the older generic MFA deprecation note.
Management API deprecation callout
EXAMPLES.md
Adds a deprecation warning for UsersAPIClient in the Management API section and notes next-major-version removal.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 I nibbled the docs with a careful grin,
Old MFA notes out, new guidance tucked in.
UsersAPIClient got a sunset sign,
And MfaApiClient now lights the line.
🥕 Hoppity hop, the examples shine!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main documentation change by adding a deprecation notice for UsersAPIClient in the Management API example.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/sync-2026-06-25

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

- Add proper ⚠️ callout at the top of the MFA with OTP section naming
  the replacement (MfaApiClient) and linking to the new section; remove
  the old plain-text "> Note" that appeared after all the examples
- Trim UsersAPIClient callout: remove the "See the CHANGELOG for
  migration guidance" line (no actionable replacement exists; the
  CHANGELOG link added noise without useful guidance)
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.

2 participants