Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[Schema Inaccuracy] Missing examples for webhooks

Aperta
#4,552 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Inizia esaminando le definizioni dei webhook OpenAPI e confrontale con gli esempi a cui si fa riferimento in github/docs#22726. Identifica ogni evento e azione del webhook rappresentati nello schema; il lavoro è completato quando ogni combinazione ha un esempio corrispondente nella descrizione OpenAPI.

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

Descrizione

documentation

Schema Inaccuracy

The schema doesn't include examples for all webhook event and their actions.
Since the GitHub docs moved to defining the Webhooks from the OpenAPI spec, we have lost the examples that were given.

See also https://github.com/github/docs/issues/22726 which was opened for restoring the examples in the github docs, however it has gone unanswered for over 2 years, and no visible progress has been made on either repo.

Expected

For there to be one example per webhook event per action

Reproduction Steps

N/A

Lingua principale
Nessun dato sulla lingua
Stelle
1.6k
Fork
342
Merge medio
2h 23m
PR unite (30g)
57

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.

Altre issue di github/rest-api-description

Tutte le issue di github/rest-api-description

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.