OpenAPITools / OpenAPITools/openapi-diff
Schema description update should be considered as a metadata change
Personne n'a encore pris cette issue.
- Langage dominant
- Java
- Étoiles
- 1.1k
- Forks
- 190
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Reproduisez le diff OpenAPI fourni, puis examinez core/src/main/java/org/openapitools/openapidiff/core/model/ChangedSchema.java autour de la ligne 160 indiquée, ainsi que ChangedMetadata.java et la gestion des métadonnées dans ChangedSchema.java. Le travail est terminé lorsqu’une modification limitée à la description d’un schéma est signalée comme une modification des métadonnées plutôt que simplement comme rétrocompatible.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- java
- Domaine
- api
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 45/100