[Schema Inaccuracy] Checks and Actions request IDs are missing int64 formats
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 70/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 冷清
- 技术栈
- json, openapi
- 领域
- api
调研方向
从 descriptions/api.github.com/api.github.com.2026-03-10.json 下载带版本的描述，并使用 jq 检查指定的 components.parameters 条目。将其 ID schema 与 Check Run、Check Suite、Workflow Run 和 Job 响应中的 ID 字段进行比较。当受影响的请求参数和对应的响应 ID 在所报告的描述中始终声明为 type integer 且 format int64 时，即表示完成。
由索引模型根据 Issue 内容生成。
描述
Schema Inaccuracy
The current api.github.com OpenAPI descriptions for both 2022-11-28 and 2026-03-10 omit format: int64 from these ID parameters:
#/components/parameters/workflow-run-check-suite-id/schema#/components/parameters/check-run-id/schema#/components/parameters/job-id/schema
They are used by operations such as:
GET /repos/{owner}/{repo}/actions/runs?check_suite_id=...GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotationsGET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs
These parameters consume IDs returned by the same API. In particular, the Check Run and Check Suite response schemas already describe their IDs as int64, while the corresponding request parameters remain unformatted integer. Workflow Run and Job schemas have similar missing formats.
This causes generated clients to expose narrower parameter types than the IDs they may receive. For example, Octokit now represents fields explicitly marked int64 as number | bigint, but these request parameters are still generated as number.
This is related to, but does not duplicate, the existing Workflow Run run-id reports #4511 and #5733, and the Check Suite response schema report #4076.
Expected
The parameters above should declare:
{
"type": "integer",
"format": "int64"
}
The corresponding Workflow Run and Job response ID fields should also use format: int64 where they represent the same IDs.
Reproduction Steps
- Download either current versioned description:
curl -O https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.2026-03-10.json
- Inspect the affected parameter schemas:
jq '.components.parameters["workflow-run-check-suite-id"], .components.parameters["check-run-id"], .components.parameters["job-id"]' api.github.com.2026-03-10.json
- Each parameter is currently
type: integerwithoutformat: int64. Generate a client from the description and compare those request parameter types with response IDs that are already markedint64.
- 主要语言
- 没有语言数据
- 星标
- 1.6k
- 派生
- 345
- 平均合并
- 6 小时
- 30 天内合并 PR
- 82
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
github/rest-api-description 的其他 Issue
-
难度 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 小时 新手友好度 84/100
paperclipai/paperclip#14982 ·
维护者通常 1 天内回复
-
cbor
难度 2/5 1-3 小时 新手友好度 84/100
FasterXML/jackson-dataformats-binary#844 ·
维护者通常 1 天内回复
-
HasBacktrace Priority-Critical
难度 2/5 1-3 小时 新手友好度 78/100
azerothcore/azerothcore-wotlk#27921 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
lawndoc/stack-back#123 ·
-
type/bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复