False positive breaking change when making a required request body optional

Abierto
#329 0 comentarios 6 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

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

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.

Descripción

Breaking/Non-Breaking classification

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 :)

Lenguaje dominante
Java
Estrellas
1.1k
Forks
190
Sin PR fusionados en 30 d

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.

Más de OpenAPITools/openapi-diff

Todos los issues de OpenAPITools/openapi-diff

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.