Skip to content

spec(v1.0): Implement Strict Catalog JSON Schema Restrictions and Consolidation #1629

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

Open
jacobsimionato wants to merge 10 commits into
base: main
Choose a base branch
from
+351 −104
Open

spec(v1.0): Implement Strict Catalog JSON Schema Restrictions and Consolidation #1629

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a746cd8
Fix catalogs format
jacobsimionato Jun 12, 2026
3205847
Address feedback
jacobsimionato Jun 12, 2026
a32a8c1
Update specification/v1_0/docs/a2ui_protocol.md
jacobsimionato Jun 15, 2026
23f3955
Merge branch 'main' into catalog-format
jacobsimionato Jun 16, 2026
1de4c75
Fix formatting
jacobsimionato Jun 16, 2026
e6347f8
Combine sections
jacobsimionato Jun 16, 2026
14e9a37
Add example
jacobsimionato Jun 16, 2026
5aefd69
Remove everything being dynamic
jacobsimionato Jun 17, 2026
f7b84ae
Fix comments
jacobsimionato Jun 17, 2026
5b3d785
Fix formatting
jacobsimionato Jun 17, 2026
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
135 changes: 72 additions & 63 deletions specification/v1_0/catalogs/basic/catalog.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"type": "object",
"properties": {
Expand All @@ -30,6 +27,10 @@
"description": "A hint for the base text style.",
"enum": ["caption", "body"],
"default": "body"
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "text"]
Expand All @@ -43,9 +44,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"type": "object",
"properties": {
Expand All @@ -71,6 +69,10 @@
"description": "A hint for the image size and style.",
"enum": ["icon", "avatar", "smallFeature", "mediumFeature", "largeFeature", "header"],
"default": "mediumFeature"
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "url"]
Expand All @@ -84,9 +86,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"type": "object",
"properties": {
Expand Down Expand Up @@ -171,6 +170,10 @@
"additionalProperties": false
}
]
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "name"]
Expand All @@ -184,9 +187,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"type": "object",
"properties": {
Expand All @@ -200,6 +200,10 @@
"posterUrl": {
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/DynamicString",
"description": "The URL of the poster image to display before the video plays."
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "url"]
Expand All @@ -213,9 +217,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"type": "object",
"properties": {
Expand All @@ -229,6 +230,10 @@
"description": {
"description": "A description of the audio, such as a title or summary.",
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/DynamicString"
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "url"]
Expand All @@ -242,9 +247,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"type": "object",
"description": "A layout component that arranges its children horizontally. To create a grid layout, nest Columns within this Row.",
Expand Down Expand Up @@ -275,6 +277,10 @@
"description": "Defines the alignment of children along the cross axis (vertically). This is similar to the CSS 'align-items' property, but uses camelCase values (e.g., 'start').",
"enum": ["start", "center", "end", "stretch"],
"default": "stretch"
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "children"]
Expand All @@ -288,9 +294,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"type": "object",
"description": "A layout component that arranges its children vertically. To create a grid layout, nest Rows within this Column.",
Expand Down Expand Up @@ -321,6 +324,10 @@
"description": "Defines the alignment of children along the cross axis (horizontally). This is similar to the CSS 'align-items' property.",
"enum": ["center", "end", "start", "stretch"],
"default": "stretch"
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "children"]
Expand All @@ -334,9 +341,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"type": "object",
"properties": {
Expand All @@ -358,6 +362,10 @@
"description": "Defines the alignment of children along the cross axis.",
"enum": ["start", "center", "end", "stretch"],
"default": "stretch"
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "children"]
Expand All @@ -371,9 +379,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"type": "object",
"properties": {
Expand All @@ -383,6 +388,10 @@
"child": {
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentId",
"description": "The ID of the single child component to be rendered inside the card. To display multiple elements, you MUST wrap them in a layout component (like Column or Row) and pass that container's ID here. Do NOT pass multiple IDs or a non-existent ID. Do NOT define the child component inline."
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "child"]
Expand All @@ -396,9 +405,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"type": "object",
"properties": {
Expand All @@ -424,6 +430,10 @@
"required": ["title", "child"],
"additionalProperties": false
}
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "tabs"]
Expand All @@ -437,9 +447,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"type": "object",
"properties": {
Expand All @@ -453,6 +460,10 @@
"content": {
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentId",
"description": "The ID of the component to be displayed inside the modal. Do NOT define the component inline."
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "trigger", "content"]
Expand All @@ -466,9 +477,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"type": "object",
"properties": {
Expand All @@ -480,6 +488,10 @@
"description": "The orientation of the divider.",
"enum": ["horizontal", "vertical"],
"default": "horizontal"
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component"]
Expand All @@ -493,9 +505,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/Checkable"
},
Expand All @@ -517,6 +526,10 @@
},
"action": {
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/Action"
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "child", "action"]
Expand All @@ -530,9 +543,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/Checkable"
},
Expand All @@ -559,6 +569,10 @@
"description": "The type of input field to display.",
"enum": ["longText", "number", "shortText", "obscured"],
"default": "shortText"
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "label"]
Expand All @@ -572,9 +586,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/Checkable"
},
Expand All @@ -591,6 +602,10 @@
"value": {
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/DynamicBoolean",
"description": "The current state of the checkbox (true for checked, false for unchecked)."
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "label", "value"]
Expand All @@ -604,9 +619,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/Checkable"
},
Expand Down Expand Up @@ -660,6 +672,10 @@
"type": "boolean",
"description": "If true, displays a search input to filter the options.",
"default": false
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "options", "value"]
Expand All @@ -673,9 +689,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/Checkable"
},
Expand Down Expand Up @@ -706,6 +719,10 @@
"type": "integer",
"minimum": 1,
"description": "The number of discrete divisions in the slider range. If specified, the slider will snap to discrete values."
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "value", "max"]
Expand All @@ -719,9 +736,6 @@
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/ComponentCommon"
},
{
"$ref": "#/$defs/CatalogComponentCommon"
},
{
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/Checkable"
},
Expand Down Expand Up @@ -800,6 +814,10 @@
"label": {
"$ref": "https://a2ui.org/specification/v1_0/common_types.json#/$defs/DynamicString",
"description": "The text label for the input field."
},
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
},
"required": ["component", "value"]
Expand Down Expand Up @@ -1222,15 +1240,6 @@
}
},
"$defs": {
"CatalogComponentCommon": {
"type": "object",
"properties": {
"weight": {
"type": "number",
"description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
}
}
},
"surfaceProperties": {
"type": "object",
"properties": {
Expand Down
Loading
Loading