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] Example and schema mismatch for `#/paths/~1advisories/get`

Đang mở
  • Có gì không ổn?
#5,479 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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
55/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

So sánh schema cho #/paths/~1advisories/get với ví dụ tại #/components/examples/global-advisory-items/value, tập trung vào trường id bị thiếu. Công việc hoàn tất khi schema và ví dụ khớp nhau đối với các phiên bản fpt, ghec và GHES được nêu.

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

Mô tả

documentation

Schema Inaccuracy

This is the json ref for the example

#/components/examples/global-advisory-items/value

The field id doesn't exist in the schema, but exists in the example.

Here's a snippet

    1: [ {
>   2:   "id" : 1,
    3:   "ghsa_id" : "GHSA-abcd-1234-efgh",
    4:   "cve_id" : "CVE-2050-00000",
    5:   "url" : "https://api.github.com/advisories/GHSA-abcd-1234-efgh",
    6:   "html_url" : "https://github.com/advisories/GHSA-abcd-1234-efgh",

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • fpt
  • ghec
  • ghes-3.14
  • ghes-3.15
  • ghes-3.16
  • ghes-3.17
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
1.6k
Fork
345
Merge trung bình
6 giờ
Pull request đã merge (30 ngày)
82

Chuẩn bị môi trường

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.