FDC3/packages/fdc3-schema/schemas/api/fdc3UserInterfaceChannels.schema.json at 9e0c4042c2552e988eaadcd37b78c1a7d1cb88e1 · finos/FDC3 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://fdc3.finos.org/schemas/next/api/fdc3UserInterfaceChannels.schema.json",
  "title": "Fdc3 UserInterface Channels",
  "description": "Setup message sent by the DA proxy code in getAgent() to a channel selector UI in an iframe with the channel definitions and current channel selection.",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/$defs/Fdc3UserInterfaceChannelsBase"
    },
    {
      "$ref": "fdc3UserInterfaceMessage.schema.json"
    }
  ],
  "$defs": {
    "Fdc3UserInterfaceChannelsBase": {
      "type": "object",
      "properties": {
        "type": {
          "title": "Fdc3 UserInterface Channels Message Type",
          "const": "Fdc3UserInterfaceChannels"
        },
        "payload": {
          "title": "Fdc3 UserInterface Channels Payload",
          "type": "object",
          "properties": {
            "userChannels": {
              "title": "User Channels",
              "description": "User Channel definitions.```````s",
              "type": "array",
              "items": {
                "$ref": "api.schema.json#/definitions/Channel"
              }
            },
            "selected": {
              "title": "Selected Channel",
              "description": "The id of the channel that should be currently selected, or `null` if none should be selected.",
              "oneOf": [
                {"type": "string"}, {"type": "null"}
              ]
            }
          },
          "additionalProperties": false,
          "required": ["userChannels", "selected"]
        }
      },
      "required": [
        "type",
        "payload"
      ],
      "additionalProperties": false
    }
  }
}