Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[Schema Inaccuracy] Missing examples for webhooks

Open
#4,552 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi
Domain
api

Research direction

Start by inspecting the OpenAPI webhook definitions and compare them with the examples referenced in github/docs#22726. Identify every webhook event and action represented in the schema; done means each combination has a corresponding example in the OpenAPI description.

Written by the indexing model from the issue text.

Description

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

Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.