OpenAPITools / OpenAPITools/openapi-diff

Markdown output does not specify whether the change is backward-compatible or not

Ouverte
#766 1 commentaire 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

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

Description

From testing the tools and looking at the example Markdown output in the project README, it seems like this output doesn't specify whether a change is backward compatible or not, unlike HTML or the default CLI output.

https://github.com/OpenAPITools/openapi-diff?tab=readme-ov-file#markdown-1

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 l’exemple de sortie Markdown du README du projet et comparez-le avec la sortie HTML et la sortie CLI par défaut mentionnées dans l’issue. Suivez ensuite la génération du rapport Markdown ; le travail sera terminé lorsque la sortie Markdown indiquera, de manière cohérente avec les autres formats, si chaque changement est rétrocompatible.

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

Recevez les nouvelles issues par e-mail

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