[Schema Inaccuracy] Imprecise units in check-run `output.summary` and `output.text` fields
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
- 35/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- github, openapi
- Lĩnh vực
- api, documentation
Hướng nghiên cứu
Bắt đầu bằng cách xác định schema OpenAPI và phần mô tả được kết xuất cho các trường output.summary và output.text của đầu ra check-run trong endpoint /repos/{owner}/{repo}/check-runs. Xác nhận maxLength 65535 được biểu diễn như thế nào và xác định cách diễn đạt chính xác về đơn vị cần dùng; công việc được xem là hoàn tất khi schema và tài liệu endpoint không còn để giới hạn này ở trạng thái mơ hồ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Schema Inaccuracy
The /repos/{owner}/{repo}/check-runs's parameter body.output.summary, body.output.text describe a max length of 65535 "characters" in their description.
The summary of the check run. This parameter supports Markdown. Maximum length: 65535 characters."
The the encoding of a "character" is not specified, which can lead to confusion, as described in https://github.com/github/docs/issues/35252. Based on that issue, "character" in this case is seemingly referring to a 1-byte ascii making the "character" limit a "byte limit" in practice. However since utf8 is supported and rendered, the character count can be far less in practice, especially for check-runs which use non-latin languages as their output.
This confusion might be considered to be clarified since the schema specifies the field's output.summary.maxLength. However OpenAPI is also unclear about if maxLength refers to bytes, characters of a given encoding, etc, and also the maxLength field is not rendered in the Github API docs.
- Ngôn ngữ chính
- Không có dữ liệu ngôn ngữ
- Star
- 1.6k
- Fork
- 342
- Merge trung bình
- 2 giờ 23 phút
- Pull request đã merge (30 ngày)
- 57
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của github/rest-api-description
-
feature
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
github/rest-api-description#7220 ·
-
feature
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
github/rest-api-description#7201 ·
-
feature
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
github/rest-api-description#7163 ·
-
Runner deprecations: registration_deprecates_at is declared on the response but never returned Đang mởfeature
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
github/rest-api-description#7162 ·
-
feature
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
github/rest-api-description#7135 ·
Tất cả issue của github/rest-api-description
Issue tương tự
-
Area: Excel support
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
orbeon/orbeon-forms#7893 ·
-
essnmx good first issue
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 95/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
yeti-platform/yeti#1380 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
modelcontextprotocol/python-sdk#3566 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
griptape-ai/griptape#2353 ·