WebSocket AsyncAPI

Отдельная документация realtime-контура CORP - HiRo. HTTP API продолжает жить в OpenAPI, а WebSocket-контур документируется отдельно через AsyncAPI, без смешивания двух протоколов в одной схеме.

Точка подключения

{{ ws_endpoint_url }}

Browser получает одноразовый билет через POST /api/auth/ws-ticket/ и подключается с ?ticket=<one_time_ticket>. Non-browser client может использовать заголовок Authorization: Bearer <jwt_access_token>.

Что описано

В схеме отражены клиентские action-сообщения и серверные realtime-события для чатов, уведомлений, typing, реакций, read-sync и procurement updates.

Почему отдельно

Swagger и ReDoc используют OpenAPI-схему HTTP API. Для WebSocket-протокола отдельный AsyncAPI-документ чище, понятнее и лучше масштабируется.

Содержимое AsyncAPI

{{ schema_text }}