OpenAPITools / OpenAPITools/openapi-diff

Show additions / changes to schema body

Abierto
#207 4 comentarios 4 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

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

Descripción

Is it possible to show non-breaking changes (i.e. added fields) to the schema body?
The current output simply states "changed body: 'application/json'"

If I reverse the comparison I get a message:
Changed body: 'application/json'
Missing property: [n].id (integer)

So a useful message would be:
Changed body: 'application/json'
Added property: [n].id (integer)

image

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

Comienza reproduciendo la comparación de OpenAPI descrita en la issue, incluida la comparación inversa, y sigue el recorrido hasta donde se formatean los cambios del schema-body. Actualiza la ruta de reporting para distinguir las propiedades añadidas de las propiedades ausentes y, después, verifica que la salida incluya una entrada “Added property” como [n].id (integer) junto al mensaje sobre el body cambiado.

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

Evaluación

Stack tecnológico
java
Área
api
Tipo de issue
Nueva funcionalidad
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.