Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

[Schema Inaccuracy] Missing examples for webhooks

未关闭
#4,552 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
openapi
领域
api

调研方向

首先检查 OpenAPI webhook 定义,并将其与 github/docs#22726 中引用的示例进行比较。识别 schema 中表示的每个 webhook 事件和操作;完成的标准是每个组合在 OpenAPI 描述中都有对应的示例。

由索引模型根据 Issue 内容生成。

描述

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

主要语言
没有语言数据
星标
1.6k
派生
342
平均合并
2 小时 23 分钟
30 天内合并 PR
57

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

github/rest-api-description 的其他 Issue

查看 github/rest-api-description 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。