incompatible api diff result when one of property in model becomes not required

Abierto
#535 2 comentarios 1 reacción 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 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.

Descripción

Breaking/Non-Breaking classification

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"
        ], ...
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.