OpenAPITools / OpenAPITools/openapi-diff

Support for detecting changes in webhooks

Aperta
#793 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

OpenAP 3.1.0 Support
Lingua principale
Java
Stelle
1.1k
Fork
190
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia eseguendo la riproduzione di OpenApiCompare.fromLocations con le specifiche allegate webhook1.txt e webhook2.txt. Traccia il modo in cui vengono confrontati i webhook di OpenAPI 3.1, quindi verifica che la rimozione di un webhook e la modifica del suo payload vengano segnalate come differenze. Il lavoro è completato quando entrambi i casi producono differenze per le specifiche fornite.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java, openapi
Ambito
api
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.