[Schema Inaccuracy] `X-GitHub-Hook-Installation-Target-Type` and `X-GitHub-Hook-Installation-Target-Id` are insufficiently documented (and incorrect)
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 68/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- openapi
- 领域
- api
调研方向
从本 issue 中包含的两个 webhook header schema 条目开始,将它们与链接的 delivery-headers 文档和之前的报告进行比较。验证每个条目的有效 Target-Type 值以及 Target-Id 映射,然后更新 schema 类型和描述,使文档中的值和标识符准确无误。
由索引模型根据 Issue 内容生成。
描述
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'srepositoryfor repository hooks andintegrationfor app hooks, I have never tested org hooks so I've no idea what that uses - specify what
Target-Idmaps to for each type, as far as I can tell forrepositoryit's the repository id and forintegrationit's the app id - also the
Target-Idis currently typed as astring, but all of them are numbers (/ integers)
Previous reports
- 主要语言
- 没有语言数据
- 星标
- 1.6k
- 派生
- 345
- 平均合并
- 6 小时
- 30 天内合并 PR
- 82
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
github/rest-api-description 的其他 Issue
-
feature
难度 1/5 1 小时以内 新手友好度 88/100
github/rest-api-description#7266 · 1 条评论 ·
维护者通常 1 天内回复
-
feature
难度 2/5 1-3 小时 新手友好度 82/100
github/rest-api-description#7246 ·
维护者通常 1 天内回复
-
feature
难度 2/5 1-3 小时 新手友好度 85/100
github/rest-api-description#7220 ·
维护者通常 1 天内回复
-
feature
难度 2/5 1-3 小时 新手友好度 82/100
github/rest-api-description#7201 ·
维护者通常 1 天内回复
-
feature
难度 2/5 1-3 小时 新手友好度 72/100
github/rest-api-description#7163 ·
维护者通常 1 天内回复
查看 github/rest-api-description 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 86/100
modelcontextprotocol/go-sdk#1340 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
modelcontextprotocol/ext-skills#156 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 75/100
MystenLabs/MemWal#1104 · 1 条评论 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
Effect-TS/effect#8728 · 1 条评论 ·
维护者通常 1 天内回复
-
account-pool bug
难度 2/5 1-3 小时 新手友好度 76/100
lidge-jun/opencodex#6571 · 1 条评论 ·
维护者通常 1 天内回复