Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[Schema Inaccuracy] Missing examples for webhooks

Đang mở
#4,552 2 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ó
4/5
Thời gian dự kiến
3-5 ngày
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ệ
openapi
Lĩnh vực
api

Hướng nghiên cứu

Bắt đầu bằng cách kiểm tra các định nghĩa webhook của OpenAPI và so sánh chúng với các ví dụ được tham chiếu trong github/docs#22726. Xác định mọi sự kiện và hành động webhook được biểu diễn trong schema; công việc được xem là hoàn tất khi mỗi tổ hợp đều có một ví dụ tương ứng trong phần mô tả OpenAPI.

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

Mô tả

documentation

Schema Inaccuracy

The schema doesn't include examples for all webhook event and their actions.
Since the GitHub docs moved to defining the Webhooks from the OpenAPI spec, we have lost the examples that were given.

See also https://github.com/github/docs/issues/22726 which was opened for restoring the examples in the github docs, however it has gone unanswered for over 2 years, and no visible progress has been made on either repo.

Expected

For there to be one example per webhook event per action

Reproduction Steps

N/A

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

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.