Schema description update should be considered as a metadata change
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 45/100
Línea de trabajo
Reproduce el diff de OpenAPI proporcionado y, a continuación, inspecciona core/src/main/java/org/openapitools/openapidiff/core/model/ChangedSchema.java alrededor de la línea 160 mencionada, junto con ChangedMetadata.java y el manejo de metadatos en ChangedSchema.java. Se considera terminado cuando un cambio que solo afecta a la descripción de un esquema se informa como un cambio de metadatos, en lugar de informarse simplemente como compatible con versiones anteriores.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Hello,
When diffing this spec:
openapi: 3.0.3
info:
title: Test
paths:
/foo:
post:
requestBody:
content:
application/json:
schema:
type: string
description: desc v1
with this one:
openapi: 3.0.3
info:
title: Test
paths:
/foo:
post:
requestBody:
content:
application/json:
schema:
type: string
description: desc v2
I get the following output:
==========================================================================
== API CHANGE LOG ==
==========================================================================
Test
--------------------------------------------------------------------------
-- What's Changed --
--------------------------------------------------------------------------
- POST /foo
Request:
- Changed application/json
Schema: Backward compatible
--------------------------------------------------------------------------
-- Result --
--------------------------------------------------------------------------
API changes are backward compatible
--------------------------------------------------------------------------
Since only the description field changed, I would expect a "metadata" change instead of a "compatible" one.
Changes to the description are correctly marked as metadata ones internally (see here and here) but I suspect the final value that is picked up to be the default one returned here. I don't have the time or means to debug it further however.
Tested version: 2.1.0-beta.11
- Lenguaje dominante
- Java
- Estrellas
- 1.1k
- Forks
- 190
- Métricas de merge de PR
- Sin PR fusionados en 30 d
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 ·
-
bug OpenAP 3.1.0 Support
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
OpenAPITools/openapi-diff#910 · 1 comentario ·
-
Render capabilities
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
OpenAPITools/openapi-diff#893 · 1 comentario ·
-
Breaking/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 Java Platform: Java
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
getsentry/sentry-java#6138 · 1 comentario ·
-
bug needs triage p2
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
GoogleCloudPlatform/DataflowTemplates#4273 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
-
bug needs triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100