OpenAPITools / OpenAPITools/openapi-diff

No backward compatible changes in Schema are marked as Compatible

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

Personne n'a encore pris cette issue.

Breaking/Non-Breaking classification
Langage dominant
Java
Étoiles
1.1k
Forks
190
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Hello, Thanks alot for this great library. I am testing this library and found the following bugs when comparing Schemas,

Library version: 'org.openapitools.openapidiff:openapi-diff-core:2.1.0-beta.8'

  1. Removing an attribute from a Model is a non-backward compatible change, but It is marked as COMPATIBLE.
  2. Updating description of an attribute is a Metadata change but this is also marked as COMPATIBLE

After several tests, I deduced, The current version is able to detect any change in schema models, but all changes are marked as COMPATIBLE. I think the compatibility checks including metadata change checks are missing.

Please have a look and provide a roadmap when this feature can be fixed. Thanks alot for all the effort and excellent work.

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 les comparaisons signalées avec openapi-diff-core 2.1.0-beta.8, en vous concentrant sur la suppression de propriétés de schéma et les changements de description d’attributs. Suivez les vérifications de compatibilité du schéma ; c’est terminé lorsque les attributs de modèle supprimés sont signalés comme non compatibles et que les changements portant uniquement sur les descriptions sont classés comme des changements de métadonnées plutôt que comme compatibles.

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é
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.