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/~1orgs~1{org}~1projectsV2~1{project_number}~1fields/get`

Đang mở
  • Có gì không ổn?
#5,600 0 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
45/100
Loại issue
Lỗi
Độ rõ ràng
Khá 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 tìm các định nghĩa OpenAPI cho hai đường dẫn GET bị ảnh hưởng và tham chiếu components/examples/projects-v2-field-items/value. So sánh schema của options.name với ví dụ, sau đó xác thực cả hai endpoint bị ảnh hưởng để schema và ví dụ khớp nhau trong fpt và ghec.

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

Mô tả

feature

Schema Inaccuracy

This is the json ref for the example

#/components/examples/projects-v2-field-items/value

Schema and example mismatch.

Here's a snippet

    5:   "data_type" : "single_select",
    6:   "project_url" : "https://api.github.com/projects/67890",
    7:   "options" : [ {
    8:     "id" : "option_1",
>   9:     "name" : "Low",
   10:     "color" : "GREEN",
   11:     "description" : "Low priority items"
   12:   }, {
   13:     "id" : "option_2",

The definition of name is

          "name": {
            "type": "object",
            "description": "The display name of the option, in raw text and HTML formats.",
            "properties": {
              "raw": {
                "type": "string"
              },
              "html": {
                "type": "string"
              }
            },
            "required": [
              "raw",
              "html"
            ]
          }

This also affects

#/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1fields~1{field_id}/get

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • fpt
  • ghec
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.