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

Open Beginner friendly
#6,930 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
70/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Quiet
Tech stack
json, openapi
Domain
api

Research direction

Download the versioned description from descriptions/api.github.com/api.github.com.2026-03-10.json and inspect the named components.parameters entries with jq. Compare their ID schemas with the Check Run, Check Suite, Workflow Run, and Job response ID fields. Done means the affected request parameters and corresponding response IDs consistently declare type integer with format int64 in the reported descriptions.

Written by the indexing model from the issue text.

Description

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.
Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.