FDC3/packages/fdc3-schema/schemas/api/contextClearedEvent.schema.json at 9ed5cc0c53bf6258b02d92c4b4e10996a4c1d690 · 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
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://fdc3.finos.org/schemas/next/api/contextClearedEvent.schema.json",
  "type": "object",
  "title": "contextCleared Event",
  "description": "An event message from the Desktop Agent to an app indicating that context has been cleared on a channel.",
  "allOf": [
    {
      "$ref": "agentEvent.schema.json"
    },
    {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/ContextClearedEventType"
        },
        "payload": {
          "$ref": "#/$defs/ContextClearedEventPayload"
        },
        "meta": true
      },
      "additionalProperties": false
    }
  ],
  "$defs": {
    "ContextClearedEventType": {
      "title": "ContextCleared Event Message Type",
      "const": "contextClearedEvent"
    },
    "ContextClearedEventPayload": {
      "title": "contextCleared Event Payload",
      "type": "object",
      "properties": {
        "channelId": {
          "title": "Channel Id",
          "description": "The Id of the channel that was cleared.",
          "type": ["string", "null"]
        },
        "contextType": {
          "title": "Context Type",
          "description": "The type of context that was cleared, or null if all types were cleared.",
          "type": ["string", "null"]
        }
      },
      "required": ["channelId", "contextType"],
      "additionalProperties": false
    }
}
}