OpenAPITools / OpenAPITools/openapi-diff

ExtensionDiff in renderers (just tried console and html)

Ouverte
#839 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

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

Description

I'm implementing ExtensionDiffs, but it seems they don't make it into the renderers, or at least I don't see how they would.
I.e. I'm only using console and html.

The console renderer just lists the route as changed and says there were backward incompatible changes in the spec but no further detail.

The html renderer lists the route under "What's Changed" with an empty <ul> with class detail which then renders as a thick gray line.

It would be nice if the renderers would be able to display details about the extension differences, especially when they are breaking, but also the non-breaking ones would be interesting.

In the html renderer result there is not even an indication whether there were breaking changes or not if the breaking changes come from an extension diff.

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 suivre ExtensionDiff depuis la sortie de comparaison jusqu’aux renderers de console et HTML, en vous concentrant sur le rendu existant des changements de route et des listes de détails. C’est terminé lorsque les deux renderers affichent les détails des différences d’extension et indiquent si ces différences sont breaking ou non-breaking.

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