OpenAPITools / OpenAPITools/openapi-diff
False positive breaking change when making a required request body optional
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
If the request body of an operation changes from required to optional, the change will be detected as an incompatible change.
I argue that this is a false positive, because existing clients are still able to communicate as before.
If this issue is accepted, I would be happy to contribute a PR to fix it :)
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.
Línea de trabajo
Comienza creando o localizando un par de especificaciones de OpenAPI en las que el cuerpo de la solicitud de una operación cambie de obligatorio a opcional, y luego ejecuta la comparación que informa de cambios incompatibles. Sigue el resultado de compatibilidad para ese cambio en el cuerpo de la solicitud e inspecciona las pruebas cercanas. La tarea estará completada cuando el cambio deje de informarse como incompatible, mientras que se sigan detectando otras incompatibilidades del cuerpo de la solicitud.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java, openapi
- Área
- api, backend-api-design
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100