-
Notifications
You must be signed in to change notification settings - Fork 173
docs: add deprecation notice for UsersAPIClient in Management API example#990
Open
utkrishtsahu wants to merge 2 commits into
Open
docs: add deprecation notice for UsersAPIClient in Management API example #990utkrishtsahu wants to merge 2 commits into
utkrishtsahu wants to merge 2 commits into
Conversation
|
No actionable comments were generated in the recent review. 🎉 i️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdded deprecation callouts in ChangesAPI deprecation documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
- 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)
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.
Uh oh!
There was an error while loading. Please reload this page.
Summary
Automated documentation drift fix. 1 finding addressed (0 P1 · 1 P2 · 0 P3).
UsersAPIClientis marked@Deprecatedin 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 inEXAMPLES.mduses 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 theUsersAPIClientexample 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)
UsersAPIClientused in Management API example without a deprecation notice; class is@Deprecatedin sourceVerified as not drift:
loginWithOTPalready has a deprecation note in docs; passkey examples (signupWithPasskey/signinWithPasskey/passkeyChallenge) match current source; README install pin matches latest release3.19.0.🤖 Generated with syncing-sdk-docs skill
Summary by CodeRabbit