PeerListResult

Experimental

peer/list result: no pagination, no cursor — one snapshot carries the whole plane.

Fields and variants

• peers — Experimental
• sessionId — Experimental

Source

schema/msp/experimental/msp.schema.json#/types/PeerListResult

{
  "description": "`peer/list` result: no pagination, no cursor — one\nsnapshot carries the whole plane.",
  "properties": {
    "peers": {
      "description": "One row per live registry entry except the viewer, ordered by\nsession id ascending (required).",
      "items": {
        "$ref": "#/$defs/PeerRow"
      },
      "type": "array"
    },
    "sessionId": {
      "description": "The viewing session id (required).",
      "type": "string"
    }
  },
  "required": [
    "peers",
    "sessionId"
  ],
  "type": "object",
  "x-msp-descriptor": "peer/list",
  "x-msp-stability": "experimental"
}