[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1repos~1{owner}~1{repo}~1keys/get`

Đang mở
#5,633 0 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
50/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 định nghĩa OpenAPI cho #/paths/1repos1{owner}~1{repo}~1keys/get và ví dụ được tham chiếu #/components/examples/deploy-key-items/value. So sánh cấu trúc mảng của schema với cấu trúc phần tử của ví dụ; hoàn thành khi schema và ví dụ nhất quán.

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/deploy-key-items/value

Schema and example mismatch. The schema has an array. The example has an element.

Here's a snippet

>   1: {
    2:   "enabled" : [ {
    3:     "id" : 1,
    4:     "key" : "ssh-rsa AAA...",
    5:     "url" : "https://api.github.com/repos/octocat/Hello-World/keys/1",

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • ghes-3.14
  • ghes-3.15
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.