OpenAPITools / OpenAPITools/openapi-diff

Show additions / changes to schema body

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

Personne n'a encore pris cette issue.

enhancement
Langage dominant
Java
Étoiles
1.1k
Forks
190
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Is it possible to show non-breaking changes (i.e. added fields) to the schema body?
The current output simply states "changed body: 'application/json'"

If I reverse the comparison I get a message:
Changed body: 'application/json'
Missing property: [n].id (integer)

So a useful message would be:
Changed body: 'application/json'
Added property: [n].id (integer)

image

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

Commencez par reproduire la comparaison OpenAPI décrite dans l’issue, y compris la comparaison inversée, et suivez le chemin jusqu’à l’endroit où les modifications du schema-body sont formatées. Mettez à jour le chemin de reporting afin que les propriétés ajoutées soient distinguées des propriétés manquantes, puis vérifiez que la sortie inclut une entrée « Added property » telle que [n].id (integer) à côté du message concernant le body modifié.

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

Évaluation

Stack technique
java
Domaine
api
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

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