refactor : Deprecated the UsersAPIClient#930
Conversation
There was a problem hiding this comment.
Pull request overview
This PR marks legacy Management API surface as deprecated ahead of removal in the next major SDK version.
Changes:
- Added
@Deprecatedannotation toUsersAPIClient. - Added
@Deprecatedannotation toManagementException.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
auth0/src/main/java/com/auth0/android/management/UsersAPIClient.kt |
Deprecates the Management Users API client class. |
auth0/src/main/java/com/auth0/android/management/ManagementException.kt |
Deprecates the exception type used by Management API requests. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @Deprecated( | ||
| """ManagementException is deprecated and will be removed in the next major version of the SDK. """, | ||
| level = DeprecationLevel.WARNING | ||
| ) |
There was a problem hiding this comment.
Deprecating ManagementException will also effectively deprecate any public APIs that expose it (e.g., com.auth0.android.callback.ManagementCallback uses it in its signature). Consider deprecating those related types in the same PR or adjusting them to use a non-deprecated exception type to avoid surprising warnings for consumers.
|
|
||
|
|
||
| @Deprecated( | ||
| """ManagementException is deprecated and will be removed in the next major version of the SDK. """, |
There was a problem hiding this comment.
The deprecation message string has a trailing space before the closing quotes, which will show up in the compiler warning text ("SDK. "). Remove the extra whitespace so the warning message is clean.
| """ManagementException is deprecated and will be removed in the next major version of the SDK. """, | |
| """ManagementException is deprecated and will be removed in the next major version of the SDK.""", |
| @Deprecated( | ||
| """ManagementException is deprecated and will be removed in the next major version of the SDK. """, | ||
| level = DeprecationLevel.WARNING | ||
| ) |
There was a problem hiding this comment.
The PR description/title mention deprecating UsersAPIClient, but this change also deprecates ManagementException. Please update the PR description (or split the change) so release notes and reviewers don't miss this additional public API deprecation.
Changes
This PR deprecates the
UsersAPIClient. This will be removed from the SDK in the next major versionChecklist
I have read the Auth0 general contribution guidelines
I have read the Auth0 Code of Conduct
All existing and new tests complete without errors