Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[Schema Inaccuracy] /orgs/{org}/dependabot/alerts schema is missing 'page'

Đang mở Phù hợp với người mới
#4,350 2 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
68/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
openapi
Lĩnh vực
api

Hướng nghiên cứu

Bắt đầu bằng cách xác định schema OpenAPI cho GET /orgs/{org}/dependabot/alerts và so sánh các tham số của schema với tài liệu Dependabot được liên kết và các endpoint cảnh báo khác của tổ chức. Thêm tham số page còn thiếu và xác minh rằng schema khớp với các liên kết phân trang của endpoint cũng như hỗ trợ các client được tạo sử dụng page.

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

Mô tả

documentation

Schema Inaccuracy

The API endpoint to get dependabot alerts for an org/enterprise do not contain the page parameter.

When calling these endpoints, the returned links for rel=next etc. include the page parameter. Using the page parameter in subsequent requests works like expected, therefore the schema seems to be inconsistent with the implementation here.

https://docs.github.com/en/rest/dependabot/alerts?apiVersion=2022-11-28#list-dependabot-alerts-for-an-organization

Other Organizational Alert Endpoints (Secret Scanning etc.) have the page parameter specified in the schema.

Expected

The schema should include the page parameter for the endpoint.

Reproduction Steps

  1. Call Endpoint
  2. Response data returns links with the page set in the links section.

As I am using an lib that is auto generated from the schemas this creates issues as it tries to use a value for page on an object that does not know 'page'.

Thanks :)

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
1.6k
Fork
342
Merge trung bình
2 giờ 23 phút
Pull request đã merge (30 ngày)
57

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.