[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1enterprises~1{enterprise}~1consumed-licenses/get`

Đang mở
#5,485 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
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, documentation

Hướng nghiên cứu

Tìm trong phần mô tả OpenAPI components/examples/get-consumed-licenses/value và thao tác GET tại /enterprises/{enterprise}/consumed-licenses. So sánh các trường trong ví dụ với schema tương ứng, sau đó xác thực rằng schema và ví dụ đã được đồng bộ hóa và rằng sự không khớp github_com_enterprise_role được báo cáo đã được giải quyết.

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

Mô tả

content documentation

Schema Inaccuracy

This is the json ref for the example

#/components/examples/get-consumed-licenses/value

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

Here's a snippet

   29:     "visual_studio_subscription_user" : false,
   30:     "license_type" : "enterprise",
   31:     "github_com_profile" : "",
   32:     "github_com_member_roles" : [ ],
>  33:     "github_com_enterprise_role" : "",
   34:     "github_com_enterprise_roles" : [ ],
   35:     "github_com_verified_domain_emails" : [ ],
   36:     "github_com_saml_name_id" : "",
   37:     "github_com_orgs_with_pending_invites" : [ ],

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

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