OpenAPITools / OpenAPITools/openapi-diff

Wrong changelog generated when having objects with same field name

Abierto
#268 4 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Java
Estrellas
1.1k
Forks
190
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Lets say that the old and the new OpenAPI schemas have classes Object1 and Object2, both of which have a field myField1 without changes in-between the openapi schemas. If Obejct1.myField1 has different description than Object2.myField1, that would be detected as a change and printed in the output diff file.

Also, can you add some kind of configuration that would prevent the library to print such non-breaking changes (i.e. changed description is not a breaking change) ?

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.

Línea de trabajo

Reproduce la comparación con esquemas OpenAPI antiguos y nuevos que contengan Object1.myField1 y Object2.myField1, donde solo difieran sus descripciones. Rastrea el punto de entrada de la generación del diff del changelog y verifica por qué los campos se emparejan entre objetos. Se considera terminado cuando los campos sin cambios ya no producen un cambio falso y se define el comportamiento de configuración para suprimir los cambios de descripción que no rompen la compatibilidad hacia atrás.

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

Evaluación

Stack tecnológico
java, openapi
Área
api
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.