Introduced com.auth0.client.mgmt.types.UserId type (instead of String used previously in some methods) is not surfaced in change logs
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- java
- Domain
- documentation
Research direction
Start with the 3.8.0...3.9.0 comparison linked in the issue, then inspect the ManagementApi and UserIdentitySchema API changes involving String and UserId. Update the release notes or changelog to call out these breaking type changes, and verify that the documented changes cover the affected return and argument types.
Written by the indexing model from the issue text.
Description
Checklist
- I have looked into the Readme and Examples, and have not found a suitable solution or answer.
- I have looked into the API documentation and have not found a suitable solution or answer.
- I have searched the issues and have not found a suitable solution or answer.
- I have searched the Auth0 Community forums and have not found a suitable solution or answer.
- I agree to the terms within the Auth0 Code of Conduct.
Description
Changes like this worth a word in release notes / changelogs, IMHO :")
Would be nice if String replacement with com.auth0.client.mgmt.types.UserId surfaced clearly as it breaks plenty of things around com.auth0.client.mgmt.ManagementApi ...
Sorry, had to select "bug" label as others did not fit. Though, if it is a bug it is a documentation one :")
Reproduction
Just try to install 3.9.0 and build your project. If anything operated with UserIdentitySchema.getUserId() it will probably break as it returns now com.auth0.client.mgmt.types.UserId and not a plain String like it was in 3.8.0
Return and arguments type changed in plenty of places from String to UserId so it should be easy to catch
Additional context
No response
auth0-java version
3.9.0
Java version
25
- Dominant language
- Java
- Stars
- 319
- Forks
- 155
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 12
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from auth0/auth0-java
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
auth0/auth0-java#842 · 2 comments ·
-
bug
Difficulty 5/5 Over a week Newbie friendliness 35/100
auth0/auth0-java#911 ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 25/100
auth0/auth0-java#897 ·
-
feature request
Difficulty 1/5 Under an hour Newbie friendliness 50/100
auth0/auth0-java#754 · 2 comments ·
All issues in auth0/auth0-java
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
opensearch-project/k-NN#3597 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100