[Schema Inaccuracy] Checks and Actions request IDs are missing int64 formats
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 70/100
- Tipo di issue
- Bug
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Tranquilla
- Stack tecnologico
- json, openapi
- Ambito
- api
Direzione di ricerca
Scarica la descrizione versionata da descriptions/api.github.com/api.github.com.2026-03-10.json e ispeziona con jq le voci indicate di components.parameters. Confronta i relativi schemi degli ID con i campi ID della risposta di Check Run, Check Suite, Workflow Run e Job. Il lavoro è completato quando i parametri di richiesta interessati e i corrispondenti ID della risposta dichiarano coerentemente type integer con format int64 nelle descrizioni riportate.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 1.6k
- Fork
- 342
- Merge medio
- 2h 23m
- PR unite (30g)
- 57
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di github/rest-api-description
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
github/rest-api-description#7220 ·
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
github/rest-api-description#7201 ·
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
github/rest-api-description#7163 ·
-
Runner deprecations: registration_deprecates_at is declared on the response but never returned Apertafeature
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
github/rest-api-description#7162 ·
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
github/rest-api-description#7135 ·
Tutte le issue di github/rest-api-description
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
mksglu/context-mode#1200 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
clawsweeper:needs-maintainer-review clawsweeper:needs-product-decision clawsweeper:no-new-fix-pr impact:auth-provider issue-rating: 🌊 off-meta tidepool P2
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 80/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100