Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[Schema Inaccuracy] Checks and Actions request IDs are missing int64 formats

Aperta Adatta ai principianti
#6,930 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

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

feature

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}/annotations
  • GET /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

  1. 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
  1. 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
  1. Each parameter is currently type: integer without format: int64. Generate a client from the description and compare those request parameter types with response IDs that are already marked int64.
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

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github/rest-api-description

Tutte le issue di github/rest-api-description

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.