Introduced com.auth0.client.mgmt.types.UserId type (instead of String used previously in some methods) is not surfaced in change logs

Abierto Apto para principiantes
#887 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
68/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
java
Área
documentation

Línea de trabajo

Comienza con la comparación 3.8.0...3.9.0 enlazada en el issue y, después, inspecciona los cambios de API de ManagementApi y UserIdentitySchema relacionados con String y UserId. Actualiza las notas de la versión o el changelog para señalar estos cambios de tipo incompatibles y verifica que los cambios documentados cubran los tipos de retorno y de argumento afectados.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug
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

Lenguaje dominante
Java
Estrellas
319
Forks
155
Merge medio
1 d 1 h
PR fusionados (30 d)
12

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de auth0/auth0-java

Todos los issues de auth0/auth0-java

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.