GET all webhooks API has incorrect schema definition
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ó
- 1/5
- Thời gian dự kiến
- Dưới một giờ
- Mức phù hợp với người mới
- 52/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- postman
- Lĩnh vực
- api, documentation
Hướng nghiên cứu
Bắt đầu từ trang tài liệu team webhooks được liên kết và so sánh ví dụ phản hồi GET-all của trang đó với phản hồi Postman được hiển thị trong issue. Cập nhật ví dụ schema để cấp cao nhất là một object chứa một data array; hoàn tất khi trang không còn biểu diễn phản hồi dưới dạng array.
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
GET all webhooks API has incorrect schema definition
The documentation mentions it returns an Array: https://www.alchemy.com/docs/data/webhooks/webhooks-api-endpoints/notify-api-endpoints/team-webhooks
[
{
"data": [
{
"id": "foo",
"network": "ETH_MAINNET",
"webhook_type": "GRAPHQL",
"webhook_url": "foo",
"is_active": true,
"time_created": 42,
"addresses": [
"foo"
],
"version": "foo",
"signing_key": "foo"
}
]
}
]
However, calling it via Postman returns an object:
{
data: Array<...>
}
I think the documentation for this particular API is wrong.
- 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ó 2/5 1-3 giờ Mức phù hợp với người mới 45/100
alchemyplatform/docs#749 ·
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ự
-
area/streaming comp/gateway P2 platform/telegram type/bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
NousResearch/hermes-agent#144897 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
a:bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 83/100
Maintainer thường phản hồi trong vòng 1 ngày
-
fix(handlers): explicitly set Content-Type header in static Index handlerCó thể đã có người làm @kage-zero đã nhận hôm nay. Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
Maintainer thường phản hồi trong vòng 1 ngày
-
beginner good first issue growth
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
BistaDinesh03/critique#161 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
fix(markdown): preserve inline-code closing tags inside detailsCó thể đã có người làm Có pull request liên kết đang mở hoặc đã được merge. Đang mởbug help wanted low priority
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
eugenioenko/ttt#1205 ·
Maintainer thường phản hồi trong vòng 1 ngày