Support AsyncAPI specs for Actors exposing WebSocket / streaming APIs
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- javascript, openapi, yaml
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- JavaScript
- Stelle
- 82
- Fork
- 240
- Merge medio
- 4g 2h
- PR unite (30g)
- 44
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di apify/apify-docs
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
apify/apify-docs#3071 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
apify/apify-docs#3049 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
apify/apify-docs#2742 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 82/100
apify/apify-docs#2741 ·
I maintainer di solito rispondono entro 1 giorno
-
low priority t-unblocking tech enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
apify/apify-docs#2451 ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di apify/apify-docs
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100
nodejs/node#66743 · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement good first issue help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
OWASP/cve-lite-cli#1335 ·
I maintainer di solito rispondono entro 1 giorno
-
Channels status: needs triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
mastra-ai/mastra#27093 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
category/development priority/P1 scope/ci-cd scope/testing status/ready-for-agent type/bug
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
QwenLM/qwen-code#14225 · 3 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100