Schema description update should be considered as a metadata change
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 45/100
Direzione di ricerca
Riproduci il diff OpenAPI fornito, quindi esamina core/src/main/java/org/openapitools/openapidiff/core/model/ChangedSchema.java intorno alla riga 160 indicata, insieme a ChangedMetadata.java e alla gestione dei metadati in ChangedSchema.java. Il lavoro è completato quando una modifica che riguarda solo la descrizione di uno schema viene segnalata come modifica dei metadati anziché semplicemente come compatibile con le versioni precedenti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- Java
- Stelle
- 1.1k
- Fork
- 190
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di OpenAPITools/openapi-diff
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
OpenAPITools/openapi-diff#506 ·
-
good first issue help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
OpenAPITools/openapi-diff#364 ·
-
bug OpenAP 3.1.0 Support
Difficoltà 3/5 1-2 giorni Idoneità per principianti 68/100
OpenAPITools/openapi-diff#910 · 1 commento ·
-
Render capabilities
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
OpenAPITools/openapi-diff#893 · 1 commento ·
-
Breaking/Non-Breaking classification
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
OpenAPITools/openapi-diff#886 ·
Tutte le issue di OpenAPITools/openapi-diff
Issue simili
-
Bug Java Platform: Java
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
getsentry/sentry-java#6138 · 1 commento ·
-
bug needs triage p2
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
GoogleCloudPlatform/DataflowTemplates#4273 · 1 commento ·
-
[Studio][Bug] Bulk-deleting a full page of alert rules steps the page back while more rules remain Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
apache/rocketmq-dashboard#4654 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100