Adding a new optional property to the request/response body is considered backward incompatible.
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 25/100
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.
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?
- Lenguaje dominante
- Java
- Estrellas
- 1.1k
- Forks
- 191
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de OpenAPITools/openapi-diff
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
OpenAPITools/openapi-diff#506 ·
-
good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
OpenAPITools/openapi-diff#364 ·
-
Property `type` change on referenced component schema is silently ignoredPosiblemente ocupada @Inf1mum la tomó hace 2 días. Abiertobug OpenAP 3.1.0 Support
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
OpenAPITools/openapi-diff#910 · 1 comentario ·
-
Changes reported in operations but only securityScheme changedPosiblemente ocupada @Inf1mum la tomó hace 5 días. AbiertoRender capabilities
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
OpenAPITools/openapi-diff#893 · 2 comentarios ·
-
[Bug] Backward compatibility check fails on reordered discriminator mappingsPosiblemente ocupada @MoChiUaena la tomó hace 47 días. AbiertoBreaking/Non-Breaking classification
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
OpenAPITools/openapi-diff#886 ·
Todos los issues de OpenAPITools/openapi-diff
Issues similares
-
bug emitter:client:csharp
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
microsoft/typespec#12572 · 1 comentario · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
GCC 15.2: -Wcast-qual warning - cast discards const qualifier from pointer target type (H5trace.c)Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 73/100
Los mantenedores suelen responder en 1 día
-
[Bug] RemotingHelper.connect swaps the socket send and receive buffer configurationPosiblemente ocupada @amalsaidov la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
needs-area-label
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 2 días
-
area/ai area/backend component/zeebe kind/task
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día