OpenAPITools / OpenAPITools/openapi-diff
Support for detecting changes in webhooks
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Java
- Sterne
- 1.1k
- Forks
- 190
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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)
Note that no differences are found in this case
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
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.
Bewertung
- Tech-Stack
- java, openapi
- Bereich
- api
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100