OpenAPITools / OpenAPITools/openapi-diff

Adding a new optional property to the request/response body is considered backward incompatible.

Abierto
#264 5 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Breaking/Non-Breaking classification
Lenguaje dominante
Java
Estrellas
1.1k
Forks
190
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Hi,
Why adding a new optional property (with default value) is considered to be an incompatible change?

  • V1 client sends a request without a new field - then the default value will be used by the V2 server - [OK]
  • V1 client receives the response from the V2 server with a new field - it will simply be ignored by the V1 client - [OK]

I really do not see why the diff tool reports it as an incompatible 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

Comienza reproduciendo el informe de compatibilidad con dos especificaciones OpenAPI mínimas: una con el cuerpo de la solicitud/respuesta original y otra que añada una propiedad opcional con un valor predeterminado. Sigue cómo la herramienta de diff clasifica ese cambio en la solicitud y la respuesta, y confirma después el resultado comparándolo con el comportamiento esperado de compatibilidad hacia atrás descrito en el issue.

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

Evaluación

Stack tecnológico
java
Área
api
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.