Support AsyncAPI specs for Actors exposing WebSocket / streaming APIs
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ó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 25/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- javascript, openapi, yaml
- Lĩnh vực
- documentation
Hướng nghiên cứu
The issue names no files, tests, or entry points to start from. First check the Apify docs' existing OpenAPI documentation and how Actor API specs are published; the issue asks whether AsyncAPI support is planned, but does not define an implementation or acceptance criteria.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Apify already provides OpenAPI specs for the platform API and Actor builds, which works great for HTTP endpoints.
However, some Actors expose streaming APIs (WebSocket, SSE, real-time feeds, etc.). OpenAPI isn't really designed to describe event-driven APIs, so it’s hard to properly document these.
Have you considered supporting AsyncAPI for these cases?
AsyncAPI is commonly used to describe:
- WebSocket APIs
- streaming/event-based APIs
- publish/subscribe message flows
It could be useful if Actors were able to optionally include something like an asyncapi.yaml alongside the OpenAPI spec, so real-time APIs could be documented properly.
Curious if this has been discussed before or if there are plans in that direction.
- Ngôn ngữ chính
- JavaScript
- Star
- 82
- Fork
- 240
- Merge trung bình
- 4 ngày 3 giờ
- Pull request đã merge (30 ngày)
- 40
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 apify/apify-docs
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
apify/apify-docs#3071 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
apify/apify-docs#3049 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
apify/apify-docs#2742 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 82/100
apify/apify-docs#2741 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
low priority t-unblocking tech enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
apify/apify-docs#2451 ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của apify/apify-docs
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
Maintainer thường phản hồi trong vòng 1 ngày
-
needs triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
pbakaus/impeccable#1055 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Add: EUROTV NEWSĐang mởchannels:add check:passed
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
Maintainer thường phản hồi trong vòng 1 ngày