googleapis / googleapis/google-api-nodejs-client

The schema, not comments, should be the canonical place to find ‘readOnly’ and ‘deprecated’ status

Đang mở
#2,995 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
priority: p3 type: feature request
Ngôn ngữ chính
TypeScript
Star
12.2k
Fork
2k
Merge trung bình
1 ngày 9 giờ
Pull request đã merge (30 ngày)
24

Mô tả

I’m working with the Android Management API and I notice that a couple fields have ‘readOnly’ status, but many fields that are read only are not so annotated. And there is no use of the ‘deprecated’ annotation at all anywhere in the schema.
It’s great that these states are called out in the comments (well, better than nothing), the whole point of a json-schema is for all the attributes of an API be machine readable. Please consider making both ‘readOnly’ and ‘deprecated’ mandatory annotations in your schemas for fields that are read only or deprecated.

See https://json-schema.org/understanding-json-schema/reference/generic.html info about draft 7 and draft 2019-09

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu bằng cách xem xét các schema của repository cho Android Management API và tài liệu được tham chiếu về JSON Schema draft 7 và draft 2019-09. Công việc hoàn tất khi các trường chỉ đọc hoặc đã lỗi thời được biểu diễn nhất quán bằng các chú thích readOnly hoặc deprecated mà máy có thể đọc, thay vì chỉ bằng nhận xét.

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

Đánh giá

Công nghệ
json
Lĩnh vực
api
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

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.