OpenAPITools / OpenAPITools/openapi-diff
incompatible api diff result when one of property in model becomes not required
Abierto
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
if in new api version some property is not required anymore, new api is recognized as not compatible
old api schema definition:
"SomeDto": {
"required": [
"prop1",
"prop2",
"prop3"
], ...
new api schema definition:
"SomeDto": {
"required": [
"prop1"
], ...
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 reproduciendo la comparación con las definiciones de esquema antigua y nueva mostradas en el issue y, a continuación, sigue el rastro de dónde se clasifican como incompatibles los cambios en las propiedades requeridas. Se considera terminado cuando el diff gestiona correctamente que una propiedad pase a ser opcional, con una prueba de regresión que cubra los esquemas de ejemplo.
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