Support for detecting changes in webhooks

Offen

#793 erstellt am 17.6.2025 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 42/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: java, openapi
Bereich: api

Rechercherichtung

Beginne mit der Ausführung der Reproduktion von OpenApiCompare.fromLocations unter Verwendung der beigefügten Spezifikationen webhook1.txt und webhook2.txt. Verfolge, wie Webhooks von OpenAPI 3.1 verglichen werden, und überprüfe anschließend, dass das Entfernen eines Webhooks und das Ändern seiner Payload als Unterschiede gemeldet werden. Als erledigt gilt die Aufgabe, wenn beide Fälle für die bereitgestellten Spezifikationen Unterschiede erzeugen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

OpenAP 3.1.0 Support

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

Detect if a webhook is removed
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