docs: correctly specifying which fields will be present in Webhook API responses
Maintainer thường phản hồi trong vòng 1 ngày
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
- 45/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, documentation
Hướng nghiên cứu
Bắt đầu với tài liệu API “Get all webhooks” được liên kết và tìm schema phản hồi OpenAPI tương ứng. Kiểm tra những trường phản hồi nào được yêu cầu phải có thay vì có thể là nullable, sau đó cập nhật tài liệu hoặc schema để các trường bắt buộc được biểu diễn chính xác và xác minh tài liệu tham chiếu API đã render.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Request for updates in the documentation
- [ ] New Documentation
- [x] Updates to Existing Documentation
I was looking at the Get all webhooks API: https://www.alchemy.com/docs/data/webhooks/webhooks-api-endpoints/notify-api-endpoints/team-webhooks and noticed that all fields can be nullable.
Is this intented? Can we add required in OpenAPI spec, since in version v3.1.0 not adding required means it can be optional?
- Ngôn ngữ chính
- MDX
- Star
- 8
- Fork
- 18
- Merge trung bình
- 21 giờ 8 phút
- Pull request đã merge (30 ngày)
- 45
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Đọc 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 alchemyplatform/docs
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 95/100
alchemyplatform/docs#1168 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Wiz-remediation
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 15/100
alchemyplatform/docs#1209 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
alchemyplatform/docs#852 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 52/100
alchemyplatform/docs#753 ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của alchemyplatform/docs
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 84/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Azure-Samples/azure-search-openai-demo#3249 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug report
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
Maintainer thường phản hồi trong vòng 3 ngày
-
Password change returns 500 because `username` is used before it is setCó thể đã có người làm @10done đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
alphaonelabs/learn#138 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày