ws.yaml

asyncapi: 3.0.0
channels:
  ws:
    address: /ws
components:
  messages:
    AgentMessage:
      contentType: application/json
      name: AgentMessage
      payload:
        properties:
          from_agent_id:
            type: string
          message:
            description: Arbitrary JSON value (opaque to the protocol)
          message_id:
            type: string
          scope:
            $ref: "#/components/schemas/MessageScope"
          server_received_at:
            type: string
          type:
            const: et-agent-message
            type: string
        required:
          - type
          - message_id
          - from_agent_id
          - scope
          - server_received_at
          - message
        title: WsAgentMessage
        type: object
      title: AgentMessage
    Alive:
      contentType: application/json
      name: Alive
      payload:
        properties:
          timestamp:
            type: string
          type:
            const: et-alive
            type: string
        required:
          - type
          - timestamp
        title: WsAlive
        type: object
      title: Alive
    BroadcastMessage:
      contentType: application/json
      name: BroadcastMessage
      payload:
        properties:
          message:
            description: Arbitrary JSON value (opaque to the protocol)
          type:
            const: et-broadcast-message
            type: string
        required:
          - type
          - message
        title: WsBroadcastMessage
        type: object
      title: BroadcastMessage
    ClientEvent:
      contentType: application/json
      name: ClientEvent
      payload:
        properties:
          action:
            type: string
          capability:
            type: string
          details:
            description: Arbitrary JSON value (opaque to the protocol)
          type:
            const: et-client-event
            type: string
        required:
          - type
          - capability
          - action
          - details
        title: WsClientEvent
        type: object
      title: ClientEvent
    Connect:
      contentType: application/json
      name: Connect
      payload:
        properties:
          agent_id:
            type:
              - string
              - "null"
          type:
            const: et-connect
            type: string
        required:
          - type
        title: WsConnect
        type: object
      title: Connect
    ConnectAck:
      contentType: application/json
      name: ConnectAck
      payload:
        properties:
          agent_id:
            type: string
          status:
            $ref: "#/components/schemas/ConnectStatus"
          type:
            const: et-connect-ack
            type: string
        required:
          - type
          - agent_id
          - status
        title: WsConnectAck
        type: object
      title: ConnectAck
    Invalid:
      contentType: application/json
      name: Invalid
      payload:
        properties:
          detail:
            type: string
          message_id:
            type:
              - string
              - "null"
          type:
            const: et-invalid
            type: string
        required:
          - type
          - detail
        title: WsInvalid
        type: object
      title: Invalid
    ListAgents:
      contentType: application/json
      name: ListAgents
      payload:
        properties:
          type:
            const: et-list-agents
            type: string
        required:
          - type
        title: WsListAgents
        type: object
      title: ListAgents
    ListAgentsResponse:
      contentType: application/json
      name: ListAgentsResponse
      payload:
        properties:
          agents:
            items:
              $ref: "#/components/schemas/AgentSummary"
            type: array
          type:
            const: et-list-agents-response
            type: string
        required:
          - type
          - agents
        title: WsListAgentsResponse
        type: object
      title: ListAgentsResponse
    MessageAck:
      contentType: application/json
      name: MessageAck
      payload:
        properties:
          message_id:
            type: string
          type:
            const: et-message-ack
            type: string
        required:
          - type
          - message_id
        title: WsMessageAck
        type: object
      title: MessageAck
    MessageStatus:
      contentType: application/json
      name: MessageStatus
      payload:
        properties:
          detail:
            type: string
          message_id:
            type:
              - string
              - "null"
          status:
            $ref: "#/components/schemas/MessageDeliveryStatus"
          type:
            const: et-message-status
            type: string
        required:
          - type
          - status
          - detail
        title: WsMessageStatus
        type: object
      title: MessageStatus
    RelayBinary:
      contentType: application/json
      name: RelayBinary
      payload:
        properties:
          content:
            description: Byte array (uint8)
            items:
              format: uint8
              maximum: 255
              minimum: 0
              type: integer
            type: array
          type:
            const: et-relay-binary
            type: string
        required:
          - type
          - content
        title: WsServerRelayBinary
        type: object
      title: RelayBinary
    RelayText:
      contentType: application/json
      name: RelayText
      payload:
        properties:
          content:
            type: string
          type:
            const: et-relay-text
            type: string
        required:
          - type
          - content
        title: WsServerRelayText
        type: object
      title: RelayText
    Response:
      contentType: application/json
      name: Response
      payload:
        properties:
          message:
            type: string
          type:
            const: et-response
            type: string
        required:
          - type
          - message
        title: WsResponse
        type: object
      title: Response
    SendAgentMessage:
      contentType: application/json
      name: SendAgentMessage
      payload:
        properties:
          message:
            description: Arbitrary JSON value (opaque to the protocol)
          to_agent_id:
            type: string
          type:
            const: et-send-agent-message
            type: string
        required:
          - type
          - to_agent_id
          - message
        title: WsSendAgentMessage
        type: object
      title: SendAgentMessage
  schemas:
    AgentConnectionState:
      enum:
        - connected
        - disconnected
      type: string
    AgentSummary:
      properties:
        agent_id:
          type: string
        last_known_ip:
          type:
            - string
            - "null"
        state:
          $ref: "#/components/schemas/AgentConnectionState"
      required:
        - agent_id
        - state
      type: object
    ConnectStatus:
      enum:
        - assigned
        - reconnected
      type: string
    MessageDeliveryStatus:
      enum:
        - delivered
        - queued
        - acknowledged
        - broadcast
      type: string
    MessageScope:
      enum:
        - direct
        - broadcast
      type: string
info:
  description: Edge Toolkit WS protocol -- typed et-* messages plus relay envelopes for foreign frames.
  title: Edge Toolkit WebSocket Protocol
  version: 0.1.0
operations:
  receiveWsMessage:
    action: receive
    channel:
      $ref: "#/channels/ws"
  sendWsMessage:
    action: send
    channel:
      $ref: "#/channels/ws"
servers:
  local:
    description: Default ws-server bind address (mise run ws-server)
    host: localhost:8080
    protocol: ws