[Schema Inaccuracy] alert field of secret scanning alert webhook events have no required 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
- 55/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- openapi, typescript
- Lĩnh vực
- api
Hướng nghiên cứu
Bắt đầu bằng cách tìm component schema secret-scanning-alert-webhook và các mô tả webhook webhook-secret-scanning-alert-* được đề cập trong issue. Sử dụng ví dụ TypeScript với @octokit/openapi-webhooks-types-ghec để kiểm tra kiểu event được tạo; hoàn thành khi các thuộc tính của alert là bắt buộc thay vì bao gồm undefined.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Schema Inaccuracy
The secret-scanning-alert-webhook schema component, used by the alert field of the webhook-secret-scanning-alert-* webhooks (e.g. webhook-secret-scanning-alert-created, does not have any required fields.
The alert is the subject of the webhook and is never optional. Many of the fields of the alert are primary keys or other required elements, such as number, created_at, updated_at, url, html_url, and many more.
Expected
The alert field of all of the webhook-secret-scanning-alert- webhooks should have required properties.
Reproduction Steps
Discovered by using TypeScript and reviewing the code of the ghec REST API descriptions. Using code, it can be discovered by:
import { webhooks } from '@octokit/openapi-webhooks-types-ghec'
type SecretScanningAlertCreatedEvent = webhooks['secret-scanning-alert-created']['post']['requestBody']['content']['application/json'];
const event: SecretScanningAlertCreatedEvent;
// Review type of event - all fields have a type that includes `| undefined`
- 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 ·