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

[Schema Inaccuracy] `X-GitHub-Hook-Installation-Target-Type` and `X-GitHub-Hook-Installation-Target-Id` are insufficiently documented (and incorrect)

未关闭
#7,210 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
68/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
活跃
技术栈
openapi
领域
api

调研方向

从本 issue 中包含的两个 webhook header schema 条目开始,将它们与链接的 delivery-headers 文档和之前的报告进行比较。验证每个条目的有效 Target-Type 值以及 Target-Id 映射,然后更新 schema 类型和描述,使文档中的值和标识符准确无误。

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

描述

feature

Schema Inaccuracy

The schema for these two webhook headers only specifies:

          {
            "name": "X-Github-Hook-Installation-Target-Id",
            "in": "header",
            "example": 123123,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-Github-Hook-Installation-Target-Type",
            "in": "header",
            "example": "repository",
            "schema": {
              "type": "string"
            }
          },

the webhooks documentation is not significantly more helpful:

X-GitHub-Hook-Installation-Target-Type: The type of resource where the webhook was created.
X-GitHub-Hook-Installation-Target-ID: The unique identifier of the resource where the webhook was created.

Issue

While some hooks can be distinguished by probing the payload for optional entries like installation or organization entries, not only is this pretty ugly some events don't have such entries because e.g. they're not attached to installations in the case of github apps hooks (ping, github_app_authorization.revoked).

Currently every developer who needs this information has to reverse-engineer the values and hope they didn't miss special cases.

Expected

  • enumerate the valid values for Target-Type (as far as I can tell there's repository for repository hooks and integration for app hooks, I have never tested org hooks so I've no idea what that uses
  • specify what Target-Id maps to for each type, as far as I can tell for repository it's the repository id and for integration it's the app id
  • also the Target-Id is currently typed as a string, but all of them are numbers (/ integers)

Previous reports

主要语言
没有语言数据
星标
1.6k
派生
345
平均合并
6 小时
30 天内合并 PR
82

环境准备

从这里开始

  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 摘要。