Support AsyncAPI specs for Actors exposing WebSocket / streaming APIs
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- javascript, openapi, yaml
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- JavaScript
- スター
- 82
- フォーク
- 240
- 平均マージ
- 4日 2時間
- マージ済み PR（30日）
- 43
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
apify/apify-docs のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
apify/apify-docs#3071 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
apify/apify-docs#3049 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
apify/apify-docs#2742 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 82/100
apify/apify-docs#2741 ·
メンテナーはふだん 1 日以内に返信
-
low priority t-unblocking tech enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
apify/apify-docs#2451 ·
メンテナーはふだん 1 日以内に返信
apify/apify-docs の issue をすべて見る
似ている issue
-
area: docs good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
メンテナーはふだん 1 日以内に返信
-
Support
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
openseadragon/openseadragon#2996 ·
メンテナーはふだん 3 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
jfromaniello/url-join#134 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100