objectstack/packages/spec/json-schema/system/Subscription.json at 8ae3d928f9c95dd320e89d8629a52085fc3d2d73 · objectstack-ai/objectstack · 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
55
56
57
58
59
60
61
62
63
64
65
{
  "$ref": "#/definitions/Subscription",
  "definitions": {
    "Subscription": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Unique subscription identifier"
        },
        "events": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "record.created",
                  "record.updated",
                  "record.deleted",
                  "field.changed"
                ],
                "description": "Type of event to subscribe to"
              },
              "object": {
                "type": "string",
                "description": "Object name to subscribe to"
              },
              "filters": {
                "description": "Filter conditions"
              }
            },
            "required": [
              "type"
            ],
            "additionalProperties": false
          },
          "description": "Array of events to subscribe to"
        },
        "transport": {
          "type": "string",
          "enum": [
            "websocket",
            "sse",
            "polling"
          ],
          "description": "Transport protocol to use"
        },
        "channel": {
          "type": "string",
          "description": "Optional channel name for grouping subscriptions"
        }
      },
      "required": [
        "id",
        "events",
        "transport"
      ],
      "additionalProperties": false
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}