OpenAPITools / OpenAPITools/openapi-diff

Support for detecting changes in webhooks

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

Personne n'a encore pris cette issue.

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

Description

It would be nice to support API changes in webhooks defined with OpenAPI 3.1, in particular:

  1. Detect if a webhook is removed
  2. Detect changes in the webhook payload

Unfortunately it looks like now this is not possible.

This can be reproduced by doing:


    String oldSpec = Paths.get("webhook1.yml").toUri().toString();
    String newSpec = Paths.get("webhook2.yml").toUri().toString();

    ChangedOpenApi diff = OpenApiCompare.fromLocations(oldSpec, newSpec);

The content of boths specs are attached here (as .txt but they are .yml specs)

webhook1.txt

webhook2.txt

Note that no differences are found in this case

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 exécuter la reproduction de OpenApiCompare.fromLocations avec les spécifications jointes webhook1.txt et webhook2.txt. Suivez la manière dont les webhooks d'OpenAPI 3.1 sont comparés, puis vérifiez que la suppression d'un webhook et la modification de sa payload sont signalées comme des différences. Le travail est considéré comme terminé lorsque les deux cas produisent des différences pour les spécifications fournies.

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

Évaluation

Stack technique
java, openapi
Domaine
api
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

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