Skip to content

Refactor: Update schema to use valueMap instead of valueList, clarify data model. #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gspencergoog merged 6 commits into from
Oct 28, 2025
Merged

Refactor: Update schema to use valueMap instead of valueList, clarify data model. #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
af3497a
feat: Update A2UI schemas and examples to match new schema.
gspencergoog Oct 28, 2025
844128c
feat: add new prompt examples and update schema paths
gspencergoog Oct 28, 2025
341f351
Fix data path descriptions.
gspencergoog Oct 28, 2025
9ec721f
Update web apps to match schema.
gspencergoog Oct 28, 2025
4e8288d
Merge branch 'main' into clarify_data_update
gspencergoog Oct 28, 2025
a90d7f9
Updates evals expectations.
gspencergoog Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion a2a_samples/a2ui_contact_lookup/a2ui_examples.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,24 @@
"surfaceId": "contact-list",
"path": "/",
"contents": [
{ "key": "contacts", "valueList": [] }
{{ "key": "contacts", "valueMap": [
{{ "key": "contact1", "valueMap": [
{{ "key": "name", "valueString": "Alice Wonderland" }},
{{ "key": "phone", "valueString": "+1-555-123-4567" }},
{{ "key": "email", "valueString": "[email protected]" }},
{{ "key": "imageUrl", "valueString": "https://example.com/alice.jpg" }},
{{ "key": "title", "valueString": "Mad Hatter" }},
{{ "key": "department", "valueString": "Wonderland" }}
] }},
{{ "key": "contact2", "valueMap": [
{{ "key": "name", "valueString": "Bob The Builder" }},
{{ "key": "phone", "valueString": "+1-555-765-4321" }},
{{ "key": "email", "valueString": "[email protected]" }},
{{ "key": "imageUrl", "valueString": "https://example.com/bob.jpg" }},
{{ "key": "title", "valueString": "Construction" }},
{{ "key": "department", "valueString": "Building" }}
] }}
] }}
]
} }
]
Expand Down
58 changes: 32 additions & 26 deletions a2a_samples/a2ui_contact_lookup/a2ui_schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@

# a2ui_schema.py

A2UI_SCHEMA = """
A2UI_SCHEMA = r'''
{
"title": "A2UI Message Schema",
"description": "Describes a JSON payload for an A2UI message, which is used to dynamically construct and update user interfaces. A message MUST contain exactly ONE of the action properties: 'beginRendering', 'surfaceUpdate', 'dataModelUpdate', or 'deleteSurface'.",
"description": "Describes a JSON payload for an A2UI (Agent to UI) message, which is used to dynamically construct and update user interfaces. A message MUST contain exactly ONE of the action properties: 'beginRendering', 'surfaceUpdate', 'dataModelUpdate', or 'deleteSurface'.",
"type": "object",
"properties": {
"beginRendering": {
Expand Down Expand Up @@ -84,7 +84,7 @@
"properties": {
"text": {
"type": "object",
"description": "The text content for the heading. This can be a literal string or a reference to a value in the data model ('path', e.g. 'doc.title').",
"description": "The text content for the heading. This can be a literal string or a reference to a value in the data model ('path', e.g. '/doc/title').",
"properties": {
"literalString": {
"type": "string"
Expand All @@ -107,7 +107,7 @@
"properties": {
"text": {
"type": "object",
"description": "The text content to display. This can be a literal string or a reference to a value in the data model ('path', e.g. 'hotel.description').",
"description": "The text content to display. This can be a literal string or a reference to a value in the data model ('path', e.g. '/hotel/description').",
"properties": {
"literalString": {
"type": "string"
Expand All @@ -125,7 +125,7 @@
"properties": {
"url": {
"type": "object",
"description": "The URL of the image to display. This can be a literal string ('literal') or a reference to a value in the data model ('path', e.g. 'thumbnail.url').",
"description": "The URL of the image to display. This can be a literal string ('literal') or a reference to a value in the data model ('path', e.g. '/thumbnail/url').",
"properties": {
"literalString": {
"type": "string"
Expand Down Expand Up @@ -154,7 +154,7 @@
"properties": {
"name": {
"type": "object",
"description": "The name of the icon to display. This can be a literal string ('literal') or a reference to a value in the data model ('path', e.g. 'icon.name').",
"description": "The name of the icon to display. This can be a literal string ('literal') or a reference to a value in the data model ('path', e.g. '/icon/name').",
"properties": {
"literalString": {
"type": "string"
Expand All @@ -172,7 +172,7 @@
"properties": {
"url": {
"type": "object",
"description": "The URL of the video to display. This can be a literal string or a reference to a value in the data model ('path', e.g. 'video.url').",
"description": "The URL of the video to display. This can be a literal string or a reference to a value in the data model ('path', e.g. '/video/url').",
"properties": {
"literalString": {
"type": "string"
Expand All @@ -190,7 +190,7 @@
"properties": {
"url": {
"type": "object",
"description": "The URL of the audio to be played. This can be a literal string ('literal') or a reference to a value in the data model ('path', e.g. 'song.url').",
"description": "The URL of the audio to be played. This can be a literal string ('literal') or a reference to a value in the data model ('path', e.g. '/song/url').",
"properties": {
"literalString": {
"type": "string"
Expand All @@ -202,7 +202,7 @@
},
"description": {
"type": "object",
"description": "A description of the audio, such as a title or summary. This can be a literal string or a reference to a value in the data model ('path', e.g. 'song.title').",
"description": "A description of the audio, such as a title or summary. This can be a literal string or a reference to a value in the data model ('path', e.g. '/song/title').",
"properties": {
"literalString": {
"type": "string"
Expand Down Expand Up @@ -230,7 +230,7 @@
},
"template": {
"type": "object",
"description": "A template for generating a dynamic list of children from a data model list. `componentId` is the component to use as a template, and `dataBinding` is the path to the list in the data model.",
"description": "A template for generating a dynamic list of children from a data model list. `componentId` is the component to use as a template, and `dataBinding` is the path to the map of components in the data model. Values in the map will define the list of children.",
"properties": {
"componentId": {
"type": "string"
Expand Down Expand Up @@ -278,7 +278,7 @@
},
"template": {
"type": "object",
"description": "A template for generating a dynamic list of children from a data model list. `componentId` is the component to use as a template, and `dataBinding` is the path to the list in the data model.",
"description": "A template for generating a dynamic list of children from a data model list. `componentId` is the component to use as a template, and `dataBinding` is the path to the map of components in the data model. Values in the map will define the list of children.",
"properties": {
"componentId": {
"type": "string"
Expand Down Expand Up @@ -326,7 +326,7 @@
},
"template": {
"type": "object",
"description": "A template for generating a dynamic list of children from a data model list. `componentId` is the component to use as a template, and `dataBinding` is the path to the list in the data model.",
"description": "A template for generating a dynamic list of children from a data model list. `componentId` is the component to use as a template, and `dataBinding` is the path to the map of components in the data model. Values in the map will define the list of children.",
"properties": {
"componentId": {
"type": "string"
Expand Down Expand Up @@ -373,7 +373,7 @@
"properties": {
"title": {
"type": "object",
"description": "The tab title. Defines the value as either a literal value or a path to data model value (e.g. 'options.title').",
"description": "The tab title. Defines the value as either a literal value or a path to data model value (e.g. '/options/title').",
"properties": {
"literalString": {
"type": "string"
Expand Down Expand Up @@ -441,7 +441,7 @@
},
"value": {
"type": "object",
"description": "Defines the value to be included in the context as either a literal value or a path to a data model value (e.g. 'user.name').",
"description": "Defines the value to be included in the context as either a literal value or a path to a data model value (e.g. '/user/name').",
"properties": {
"path": {
"type": "string"
Expand Down Expand Up @@ -472,7 +472,7 @@
"properties": {
"label": {
"type": "object",
"description": "The text to display next to the checkbox. Defines the value as either a literal value or a path to data model ('path', e.g. 'option.label').",
"description": "The text to display next to the checkbox. Defines the value as either a literal value or a path to data model ('path', e.g. '/option/label').",
"properties": {
"literalString": {
"type": "string"
Expand All @@ -484,7 +484,7 @@
},
"value": {
"type": "object",
"description": "The current state of the checkbox (true for checked, false for unchecked). This can be a literal boolean ('literalBoolean') or a reference to a value in the data model ('path', e.g. 'filter.open').",
"description": "The current state of the checkbox (true for checked, false for unchecked). This can be a literal boolean ('literalBoolean') or a reference to a value in the data model ('path', e.g. '/filter/open').",
"properties": {
"literalBoolean": {
"type": "boolean"
Expand All @@ -502,7 +502,7 @@
"properties": {
"label": {
"type": "object",
"description": "The text label for the input field. This can be a literal string or a reference to a value in the data model ('path, e.g. 'user.name').",
"description": "The text label for the input field. This can be a literal string or a reference to a value in the data model ('path, e.g. '/user/name').",
"properties": {
"literalString": {
"type": "string"
Expand All @@ -514,7 +514,7 @@
},
"text": {
"type": "object",
"description": "The value of the text field. This can be a literal string or a reference to a value in the data model ('path', e.g. 'user.name').",
"description": "The value of the text field. This can be a literal string or a reference to a value in the data model ('path', e.g. '/user/name').",
"properties": {
"literalString": {
"type": "string"
Expand Down Expand Up @@ -547,7 +547,7 @@
"properties": {
"value": {
"type": "object",
"description": "The selected date and/or time value. This can be a literal string ('literalString') or a reference to a value in the data model ('path', e.g. 'user.dob').",
"description": "The selected date and/or time value. This can be a literal string ('literalString') or a reference to a value in the data model ('path', e.g. '/user/dob').",
"properties": {
"literalString": {
"type": "string"
Expand Down Expand Up @@ -577,7 +577,7 @@
"properties": {
"selections": {
"type": "object",
"description": "The currently selected values for the component. This can be a literal array of strings or a path to an array in the data model('path', e.g. 'hotel.options').",
"description": "The currently selected values for the component. This can be a literal array of strings or a path to an array in the data model('path', e.g. '/hotel/options').",
"properties": {
"literalArray": {
"type": "array",
Expand All @@ -598,7 +598,7 @@
"properties": {
"label": {
"type": "object",
"description": "The text to display for this option. This can be a literal string or a reference to a value in the data model (e.g. 'option.label').",
"description": "The text to display for this option. This can be a literal string or a reference to a value in the data model (e.g. '/option/label').",
"properties": {
"literalString": {
"type": "string"
Expand Down Expand Up @@ -628,7 +628,7 @@
"properties": {
"value": {
"type": "object",
"description": "The current value of the slider. This can be a literal number ('literalNumber') or a reference to a value in the data model ('path', e.g. 'restaurant.cost').",
"description": "The current value of the slider. This can be a literal number ('literalNumber') or a reference to a value in the data model ('path', e.g. '/restaurant/cost').",
"properties": {
"literalNumber": {
"type": "number"
Expand Down Expand Up @@ -668,7 +668,7 @@
},
"path": {
"type": "string",
"description": "An optional path to a location within the data model (e.g., 'user.name'). If omitted, the entire data model will be replaced."
"description": "An optional path to a location within the data model (e.g., '/user/name'). If omitted, or set to '/', the entire data model will be replaced."
},
"contents": {
"type": "array",
Expand All @@ -690,11 +690,16 @@
"valueBoolean": {
"type": "boolean"
},
"valueList": {
"valueMap": {
"description": "Represents a map as an adjacency list.",
"type": "array",
"items": {
"type": "object",
"description": "One entry in the map. Exactly one 'value*' property should be provided alongside the key.",
"properties": {
"key": {
"type": "string"
},
"valueString": {
"type": "string"
},
Expand All @@ -704,7 +709,8 @@
"valueBoolean": {
"type": "boolean"
}
}
},
"required": ["key"]
}
}
},
Expand All @@ -727,4 +733,4 @@
}
}
}
"""
'''
Loading