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

Đang mở Phù hợp với người mới
#6,930 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
70/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
json, openapi
Lĩnh vực
api

Hướng nghiên cứu

Tải xuống mô tả được phiên bản hóa từ descriptions/api.github.com/api.github.com.2026-03-10.json và dùng jq để kiểm tra các mục components.parameters được nêu tên. So sánh các schema ID của chúng với các trường ID phản hồi của Check Run, Check Suite, Workflow Run và Job. Được xem là hoàn tất khi các tham số yêu cầu bị ảnh hưởng và các ID phản hồi tương ứng nhất quán khai báo type integer với format int64 trong các mô tả được báo cáo.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
1.6k
Fork
342
Merge trung bình
3 giờ 33 phút
Pull request đã merge (30 ngày)
51

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của github/rest-api-description

Tất cả issue của github/rest-api-description

Issue tương tự

Thêm issue về Backend & API Design

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.