OpenAPITools / OpenAPITools/openapi-diff

Wrong changelog generated when having objects with same field name

Ouverte
#268 4 commentaires 2 réactions 0 personnes assignées Voir sur GitHub

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

Lets say that the old and the new OpenAPI schemas have classes Object1 and Object2, both of which have a field myField1 without changes in-between the openapi schemas. If Obejct1.myField1 has different description than Object2.myField1, that would be detected as a change and printed in the output diff file.

Also, can you add some kind of configuration that would prevent the library to print such non-breaking changes (i.e. changed description is not a breaking change) ?

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Reproduisez la comparaison avec d’anciens et de nouveaux schémas OpenAPI contenant Object1.myField1 et Object2.myField1, dont seules les descriptions diffèrent. Suivez le point d’entrée de la génération du diff du changelog et vérifiez pourquoi les champs sont mis en correspondance entre les objets. Le travail est terminé lorsque les champs inchangés ne produisent plus de changement erroné et que le comportement de configuration permettant de supprimer les changements de description non rétro-incompatibles est défini.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java, openapi
Domaine
api
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.