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.
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:
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.