A2UI/specification/v0_9/json/client_to_server.json at main · google/A2UI · 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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
{
  "title": "A2UI (Agent to UI) Client-to-Server Event Schema",
  "description": "Describes a JSON payload for a client-to-server event message.",
  "type": "object",
  "minProperties": 2,
  "maxProperties": 2,
  "properties": {
    "version": {
      "const": "v0.9"
    },
    "action": {
      "type": "object",
      "description": "Reports a user-initiated action from a component.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the action, taken from the component's action.event.name property."
        },
        "surfaceId": {
          "type": "string",
          "description": "The id of the surface where the event originated."
        },
        "sourceComponentId": {
          "type": "string",
          "description": "The id of the component that triggered the event."
        },
        "timestamp": {
          "type": "string",
          "format": "date-time",
          "description": "An ISO 8601 timestamp of when the event occurred."
        },
        "context": {
          "type": "object",
          "description": "A JSON object containing the key-value pairs from the component's action.event.context, after resolving all data bindings.",
          "additionalProperties": true
        }
      },
      "required": ["name", "surfaceId", "sourceComponentId", "timestamp", "context"]
    },
    "error": {
      "description": "Reports a client-side error.",
      "oneOf": [
        {
          "type": "object",
          "title": "Validation Failed Error",
          "properties": {
            "code": {
              "const": "VALIDATION_FAILED"
            },
            "surfaceId": {
              "type": "string",
              "description": "The id of the surface where the error occurred."
            },
            "path": {
              "type": "string",
              "description": "The JSON pointer to the field that failed validation (e.g. '/components/0/text')."
            },
            "message": {
              "type": "string",
              "description": "A short one or two sentence description of why validation failed."
            }
          },
          "required": ["code", "path", "message", "surfaceId"],
          "additionalProperties": false
        },
        {
          "type": "object",
          "title": "Generic Error",
          "properties": {
            "code": {
              "not": {
                "const": "VALIDATION_FAILED"
              }
            },
            "message": {
              "type": "string",
              "description": "A short one or two sentence description of why the error occurred."
            },
            "surfaceId": {
              "type": "string",
              "description": "The id of the surface where the error occurred."
            }
          },
          "required": ["code", "surfaceId", "message"],
          "additionalProperties": true
        }
      ]
    }
  },
  "oneOf": [
    {
      "required": ["action", "version"]
    },
    {
      "required": ["error", "version"]
    }
  ]
}