[Schema Inaccuracy] Checks and Actions request IDs are missing int64 formats
まだ誰も着手していません。
評価
- 難易度
- 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 スキーマを 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
- フォーク
- 342
- 平均マージ
- 2時間 23分
- マージ済み PR(30日)
- 57
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
github/rest-api-description のほかの issue
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
github/rest-api-description#7220 ·
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
github/rest-api-description#7201 ·
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
github/rest-api-description#7163 ·
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/rest-api-description#7162 ·
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/rest-api-description#7135 ·
github/rest-api-description の issue をすべて見る
似ている issue
-
Area: Excel support
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
orbeon/orbeon-forms#7893 ·
-
essnmx good first issue
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
yeti-platform/yeti#1380 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
modelcontextprotocol/python-sdk#3566 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
griptape-ai/griptape#2353 ·