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] Schema says array of objects, but response had a null value in the array alongside the objects

Đang mở
#4,531 1 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
48/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

Tìm mô tả OpenAPI cho endpoint List Public Repositories và kiểm tra schema của mảng phản hồi bằng cách đối chiếu với ví dụ được ghi trong tài liệu. Cập nhật schema để các items của nó cho phép cả các đối tượng repository tối thiểu và null, sau đó xác minh rằng mô tả endpoint khớp với phản hồi được tái hiện.

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

Mô tả

documentation

Schema Inaccuracy

https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#list-public-repositories

The List Public Repositories endpoint is supposed to return an array of minimal repository objects.

One of the values in such a response at a certain offset was null instead of a minimal repository object.

Expected

Schema should specify that array may contain null values and minimal repository objects, rather than only saying that it contains minimal repository objects.

Reproduction Steps

curl -i "https://api.github.com/repositories?since=263175046"

HTTP/1.1 200 OK
Date: Thu, 13 Feb 2025 06:21:57 GMT
Content-Type: application/json; charset=utf-8
Cache-Control: public, max-age=60, s-maxage=60
Vary: Accept,Accept-Encoding, Accept, X-Requested-With
ETag: W/"94f54685d2f34d4b33402468be31a060f63dbbe9842c0d0294064dc2805f8454"
X-GitHub-Media-Type: github.v3; format=json
Link: <https://api.github.com/repositories?since=263175278>; rel="next", <https://api.github.com/repositories{?since}>; rel="first"
x-github-api-version-selected: 2022-11-28
# …
X-GitHub-Request-Id: D170:2F4C71:38ABFF0:3A8CE3C:67AD8F86

[
  {
    "id": 263175047,
    "node_id": "MDEwOlJlcG9zaXRvcnkyNjMxNzUwNDc=",
    "name": "design-patterns-php",
    "full_name": "ninja-tn/design-patterns-php",
    "private": false,
    # …
    "deployments_url": "https://api.github.com/repos/ninja-tn/design-patterns-php/deployments"
  },
  # …
  # many lines more, omitted for brevity
  # …
  {
    "id": 263175062,
    "node_id": "MDEwOlJlcG9zaXRvcnkyNjMxNzUwNjI=",
    "name": "38671075_60",
    "full_name": "offlinesite/38671075_60",
    "private": false,
    # …
    "deployments_url": "https://api.github.com/repos/offlinesite/38671075_60/deployments"
  },
  null,
  {
    "id": 263175064,
    "node_id": "MDEwOlJlcG9zaXRvcnkyNjMxNzUwNjQ=",
    "name": "onLlineBooks",
    "full_name": "crisantus/onLlineBooks",
    "private": false,
    # …
    "deployments_url": "https://api.github.com/repos/crisantus/onLlineBooks/deployments"
  }
  # …
  # many lines more, omitted for brevity
  # …
]

There between object with id 263175062 and object with id 263175064 is a null instead of a minimal repository object.

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.