Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#6,930 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
70/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
json, openapi
Área
api

Línea de trabajo

Descarga la descripción versionada de descriptions/api.github.com/api.github.com.2026-03-10.json e inspecciona con jq las entradas indicadas de components.parameters. Compara sus esquemas de ID con los campos de ID de respuesta de Check Run, Check Suite, Workflow Run y Job. Se considera completado cuando los parámetros de solicitud afectados y los ID de respuesta correspondientes declaran de forma coherente type integer con format int64 en las descripciones indicadas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
Sin datos de lenguaje
Estrellas
1.6k
Forks
342
Merge medio
7 h 29 min
PR fusionados (30 d)
62

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github/rest-api-description

Todos los issues de github/rest-api-description

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.