OpenAPITools / OpenAPITools/openapi-diff
Renderers should display example changes, not just schema changes
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
When a ChangedMediaType has example changes but no schema changes, the renderers (Console, Markdown, Asciidoc, HTML) currently show nothing in the details section because they only render schema changes. The ChangedMediaType model has example and examples fields that could be rendered alongside schema changes.
This was discovered while fixing https://github.com/OpenAPITools/openapi-diff/issues/870 where the NPE was caused by null schema when only examples changed.
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
Commencez par localiser le modèle ChangedMediaType et les points d’entrée des renderers Console, Markdown, Asciidoc et HTML. Suivez la manière dont les changements de schéma sont ajoutés à la section details, puis vérifiez que les changements de example et examples sont également pris en charge lorsqu’il n’existe aucun changement de schéma. Confirmez la sortie de details pour les quatre renderers et vérifiez s’il existe déjà des tests de régression.
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é
- Plutôt claire
- Accessibilité débutants
- 48/100