runtime-connection

Generated reference page for spec/v1/api/runtime-connection.asyncapi.yaml.

Metadata

• Type: AsyncAPI
• Source: spec/v1/api/runtime-connection.asyncapi.yaml
• Raw: View Raw

Summary

• Title: Agent Service Runtime Connection Protocol
• Version: v1
• Channels: 17
• Servers: 1

Source

asyncapi: 2.6.0
info:
  title: Agent Service Runtime Connection Protocol
  version: v1
  description: >
    Runtime Connection Gateway 的逻辑双向协议。方向约定以 runtime 视角描述：
    `publish` 表示 runtime 发送，`subscribe` 表示 runtime 接收。
    attach 阶段显式协商统一的 SDK capability 集，
    并返回 `Session` 上下文与当前 `RuntimeConnection` 身份。
defaultContentType: application/json
servers:
  connection:
    protocol: wss
    url: api.agent-service.example.com/runtime
    description: Logical bidirectional runtime connection transport
channels:
  runtime.connection.attach.command:
    description: Runtime attach or reattach request
    publish:
      operationId: runtimeAttach
      message:
        $ref: '#/components/messages/RuntimeAttachRequest'
  runtime.connection.attach.reply:
    subscribe:
      operationId: runtimeAttachReply
      message:
        $ref: '#/components/messages/RuntimeAttachResponse'
  runtime.connection.heartbeat.command:
    publish:
      operationId: runtimeHeartbeat
      message:
        $ref: '#/components/messages/HeartbeatCommand'
  runtime.connection.heartbeat.reply:
    subscribe:
      operationId: runtimeHeartbeatReply
      message:
        $ref: '#/components/messages/HeartbeatResponse'
  runtime.connection.recover.command:
    publish:
      operationId: recoverConnections
      message:
        $ref: '#/components/messages/RecoverConnectionsCommand'
  runtime.connection.recover.reply:
    subscribe:
      operationId: recoverConnectionsReply
      message:
        $ref: '#/components/messages/RecoverConnectionsResponse'
  runtime.connection.secrets.get.command:
    publish:
      operationId: getSecrets
      message:
        $ref: '#/components/messages/GetSecretsCommand'
  runtime.connection.secrets.get.reply:
    subscribe:
      operationId: getSecretsReply
      message:
        $ref: '#/components/messages/GetSecretsResponse'
  runtime.connection.config.get.command:
    publish:
      operationId: getConfig
      message:
        $ref: '#/components/messages/GetConfigCommand'
  runtime.connection.config.get.reply:
    subscribe:
      operationId: getConfigReply
      message:
        $ref: '#/components/messages/GetConfigResponse'
  runtime.connection.kv.get.command:
    publish:
      operationId: getKV
      message:
        $ref: '#/components/messages/GetKVCommand'
  runtime.connection.kv.get.reply:
    subscribe:
      operationId: getKVReply
      message:
        $ref: '#/components/messages/GetKVResponse'
  runtime.connection.kv.set.command:
    publish:
      operationId: setKV
      message:
        $ref: '#/components/messages/SetKVCommand'
  runtime.connection.kv.set.reply:
    subscribe:
      operationId: setKVReply
      message:
        $ref: '#/components/messages/SetKVResponse'
  runtime.task.output.event:
    publish:
      operationId: publishOutputEvents
      message:
        $ref: '#/components/messages/PublishOutputEventsRequest'
  runtime.task.output.reply:
    subscribe:
      operationId: publishOutputEventsReply
      message:
        $ref: '#/components/messages/PublishOutputEventsResponse'
  service.task.input.event:
    description: Platform to runtime input delivery
    subscribe:
      operationId: receiveTaskInput
      message:
        $ref: '#/components/messages/TaskInputDelivery'
components:
  messages:
    RuntimeAttachRequest:
      name: RuntimeAttachRequest
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/RuntimeAttachRequest
    RuntimeAttachResponse:
      name: RuntimeAttachResponse
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/RuntimeAttachResponse
    HeartbeatCommand:
      name: HeartbeatCommand
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/HeartbeatCommand
    HeartbeatResponse:
      name: HeartbeatResponse
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/HeartbeatResponse
    RecoverConnectionsCommand:
      name: RecoverConnectionsCommand
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/RecoverConnectionsCommand
    RecoverConnectionsResponse:
      name: RecoverConnectionsResponse
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/RecoverConnectionsResponse
    GetSecretsCommand:
      name: GetSecretsCommand
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/GetSecretsCommand
    GetSecretsResponse:
      name: GetSecretsResponse
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/GetSecretsResponse
    GetConfigCommand:
      name: GetConfigCommand
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/GetConfigCommand
    GetConfigResponse:
      name: GetConfigResponse
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/GetConfigResponse
    GetKVCommand:
      name: GetKVCommand
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/GetKVCommand
    GetKVResponse:
      name: GetKVResponse
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/GetKVResponse
    SetKVCommand:
      name: SetKVCommand
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/SetKVCommand
    SetKVResponse:
      name: SetKVResponse
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/SetKVResponse
    PublishOutputEventsRequest:
      name: PublishOutputEventsRequest
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/PublishOutputEventsRequest
    PublishOutputEventsResponse:
      name: PublishOutputEventsResponse
      payload:
        $ref: ../schemas/commands/runtime-connection.json#/$defs/PublishOutputEventsResponse
    TaskInputDelivery:
      name: TaskInputDelivery
      payload:
        $ref: ../schemas/events/input-event.json#/$defs/TaskInputDelivery