Skip to main content

Module asyncapi

Module asyncapi 

Source
Expand description

AsyncAPI specification for WebSocket API.

This module generates an AsyncAPI 3.0 specification for the WebSocket API, documenting all channels, messages, and their schemas.

The message types are defined in super::websocket and reused here to avoid duplication.

Structs§

WebSocketApi
WebSocket API specification
WsCandleUpdate
WsCompetitionFinalStanding
WsCompetitionFinalStats
WsCompetitionGapUpdate
WsCompetitionRankChange
WsCompetitionUpdate
WsFillUpdate
WsIndexPriceUpdate
WsIndicativeMarketData
WsLiquidationStateChange
WsOrderbookUpdate
WsPositionExpired
WsRfqQuoteEntry
WsRfqQuotes
WsRfqStatusUpdate
WsTradeUpdate

Enums§

WsMarketUpdate
WsMessage

Functions§

asyncapi_spec_json
Get the AsyncAPI specification as JSON string
asyncapi_spec_with_server
Get the AsyncAPI specification with a custom server URL