ARarbicity
notifications

WebSocket Message Schemas

Changed on

Expose all WebSocket message types in the OpenAPI schema.

  • server_messages: Messages sent from server to client
  • client_messages: Messages sent from client to server

Frontend can autogenerate TypeScript types from OpenAPI schema components.

get/api/notifications/ws-schemas

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Response

Successful Response

Changes

  • ec6f27613280Revision changes
    • warning

      added the new analysing enum value to the /// response property for the response status

    • warning

      added the new encrypting enum value to the /// response property for the response status

    • warning

      added the new indexing enum value to the /// response property for the response status

    • warning

      added the new parsing enum value to the /// response property for the response status

    • info

      removed the processing enum value from the /// response property for the response status

  • 2869dee5e8caRevision changes
    • info

      added to the / response property anyOf list for the response status