Skip to content

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

Description

@hanakannzashi

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions