Skip to content

Commit faf6df8

Browse files
jacobsimionatojacobsimionato
committed
rename files
1 parent e0ab704 commit faf6df8

File tree

7 files changed

+23
-23
lines changed

7 files changed

+23
-23
lines changed

‎docs/concepts/catalogs.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ This guide defines the A2UI Catalog architecture and provides a roadmap for impl
66

77
## Catalog Definition
88

9-
A catalog is a [JSON Schema file](../specification/v0_9/json/a2ui_client_capabilities.json#L62C5-L95C6) outlining the components, functions, and themes that agents can use to define A2UI surfaces using server-driven UI. All A2UI JSON sent from the agent is validated against the chosen catalog.
9+
A catalog is a [JSON Schema file](../specification/v0_9/json/client_capabilities.json#L62C5-L95C6) outlining the components, functions, and themes that agents can use to define A2UI surfaces using server-driven UI. All A2UI JSON sent from the agent is validated against the chosen catalog.
1010

11-
[Catalog JSON Schema](../specification/v0_9/json/a2ui_client_capabilities.json#L62C5-L95C6) is below
11+
[Catalog JSON Schema](../specification/v0_9/json/client_capabilities.json#L62C5-L95C6) is below
1212

1313
```json
1414
{
@@ -81,14 +81,14 @@ For simplicity we recommend building catalogs that directly reflect a client's d
8181

8282
### Recommendations
8383

84-
| Usecase | Recommendation | Effort |
85-
| :--- | :--- | :--- |
86-
| Adding A2UI to a mature frontend | Define a catalog that mirrors your existing design system. | Medium |
84+
| Usecase | Recommendation | Effort |
85+
| :---------------------------------- | :----------------------------------------------------------------------------- | :----------------------------- |
86+
| Adding A2UI to a mature frontend | Define a catalog that mirrors your existing design system. | Medium |
8787
| Adding A2UI to a new/greenfield app | Start with Basic Catalog, then evolve into your own catalog as the app evolves | Low (assuming renderer exists) |
8888

8989
## Building a Catalog
9090

91-
A catalog is a JSON Schema file that conforms to the [Catalog schema](../specification/v0_9/json/a2ui_client_capabilities.json#L62C5-L95C6) that defines the components, themes and functions an agent can use when building a surface.
91+
A catalog is a JSON Schema file that conforms to the [Catalog schema](../specification/v0_9/json/client_capabilities.json#L62C5-L95C6) that defines the components, themes and functions an agent can use when building a surface.
9292

9393
### Example: A Minimal Catalog
9494

@@ -365,9 +365,9 @@ We recommend including the version in the catalogId. This allows using A2UI cata
365365

366366
**Recommended Pattern:**
367367

368-
| Change Type | URI Example | Description |
369-
| :--- | :--- | :--- |
370-
| **Current** | .../rizzcharts/v1/catalog.json | The stable, production schema. |
368+
| Change Type | URI Example | Description |
369+
| :----------- | :----------------------------- | :----------------------------------------------------------------- |
370+
| **Current** | .../rizzcharts/v1/catalog.json | The stable, production schema. |
371371
| **Breaking** | .../rizzcharts/v2/catalog.json | A new schema introducing renamed components or structural changes. |
372372

373373
### Handling Migrations

‎specification/v0_10/docs/a2ui_protocol.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -568,7 +568,7 @@ _Replace the entire data model:_
568568

569569
### Client to server updates
570570

571-
When `sendDataModel` is set to `true` for a surface, the client automatically appends the **entire data model** of that surface to the metadata of every message (such as `action` or user query) sent to the server that created the surface. The data model is included using the transport's metadata facility (e.g., the `metadata` field in A2A or a header in HTTP). The payload follows the schema in [`a2ui_client_data_model.json`](../json/a2ui_client_data_model.json).
571+
When `sendDataModel` is set to `true` for a surface, the client automatically appends the **entire data model** of that surface to the metadata of every message (such as `action` or user query) sent to the server that created the surface. The data model is included using the transport's metadata facility (e.g., the `metadata` field in A2A or a header in HTTP). The payload follows the schema in [`client_data_model.json`](../json/client_data_model.json).
572572

573573
- **Targeted Delivery**: The data model is sent exclusively to the server that created the surface. Data cannot leak to other agents or servers.
574574
- **Trigger:** Data is sent only when a client-to-server message is triggered (e.g., by a user action like a button click). Passive data changes (like typing in a text field) do not trigger a network request on their own; they simply update the local state, which will be sent with the next action.
@@ -824,7 +824,7 @@ A server (or agent) advertises its capabilities using the [`server_capabilities.
824824

825825
#### Client capabilities
826826

827-
The `a2uiClientCapabilities` object in the metadata follows the [`a2ui_client_capabilities.json`] schema.
827+
The `a2uiClientCapabilities` object in the metadata follows the [`client_capabilities.json`] schema.
828828

829829
**Properties:**
830830

@@ -833,7 +833,7 @@ The `a2uiClientCapabilities` object in the metadata follows the [`a2ui_client_ca
833833

834834
#### Client data model
835835

836-
When `sendDataModel` is enabled for a surface, the client includes the `a2uiClientDataModel` object in the metadata, following the [`a2ui_client_data_model.json`] schema.
836+
When `sendDataModel` is enabled for a surface, the client includes the `a2uiClientDataModel` object in the metadata, following the [`client_data_model.json`] schema.
837837

838838
**Properties:**
839839

@@ -848,7 +848,7 @@ This message is used to report a client-side error to the server.
848848
[`server_to_client.json`]: ../json/server_to_client.json
849849
[`client_to_server.json`]: ../json/client_to_server.json
850850
[`server_capabilities.json`]: ../json/server_capabilities.json
851-
[`a2ui_client_capabilities.json`]: ../json/a2ui_client_capabilities.json
852-
[`a2ui_client_data_model.json`]: ../json/a2ui_client_data_model.json
851+
[`client_capabilities.json`]: ../json/client_capabilities.json
852+
[`client_data_model.json`]: ../json/client_data_model.json
853853
[JSON Pointer]: https://datatracker.ietf.org/doc/html/rfc6901
854854
[RFC 6901]: https://datatracker.ietf.org/doc/html/rfc6901

specification/v0_10/json/a2ui_client_capabilities.json renamed to specification/v0_10/json/client_capabilities.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "https://json-schema.org/draft/2020-12/schema",
3-
"$id": "https://a2ui.org/specification/v0_10/a2ui_client_capabilities.json",
3+
"$id": "https://a2ui.org/specification/v0_10/client_capabilities.json",
44
"title": "A2UI Client Capabilities Schema",
55
"description": "A schema for the a2uiClientCapabilities object, which is sent from the client to the server as part of the A2A metadata to describe the client's UI rendering capabilities.",
66
"type": "object",

specification/v0_10/json/a2ui_client_data_model.json renamed to specification/v0_10/json/client_data_model.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "https://json-schema.org/draft/2020-12/schema",
3-
"$id": "https://a2ui.org/specification/v0_10/a2ui_client_data_model.json",
3+
"$id": "https://a2ui.org/specification/v0_10/client_data_model.json",
44
"title": "A2UI Client Data Model Schema",
55
"description": "Schema for attaching the client data model to A2A message metadata. This object should be placed in the `a2uiClientDataModel` field of the metadata.",
66
"type": "object",

‎specification/v0_9/docs/a2ui_protocol.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -574,7 +574,7 @@ _Replace the entire data model:_
574574

575575
### Client to server updates
576576

577-
When `sendDataModel` is set to `true` for a surface, the client automatically appends the **entire data model** of that surface to the metadata of every message (such as `action` or user query) sent to the server that created the surface. The data model is included using the transport's metadata facility (e.g., the `metadata` field in A2A or a header in HTTP). The payload follows the schema in [`a2ui_client_data_model.json`](../json/a2ui_client_data_model.json).
577+
When `sendDataModel` is set to `true` for a surface, the client automatically appends the **entire data model** of that surface to the metadata of every message (such as `action` or user query) sent to the server that created the surface. The data model is included using the transport's metadata facility (e.g., the `metadata` field in A2A or a header in HTTP). The payload follows the schema in [`client_data_model.json`](../json/client_data_model.json).
578578

579579
- **Targeted Delivery**: The data model is sent exclusively to the server that created the surface. Data cannot leak to other agents or servers.
580580
- **Trigger:** Data is sent only when a client-to-server message is triggered (e.g., by a user action like a button click). Passive data changes (like typing in a text field) do not trigger a network request on their own; they simply update the local state, which will be sent with the next action.
@@ -830,7 +830,7 @@ A server (or agent) advertises its capabilities using the [`server_capabilities.
830830

831831
#### Client capabilities
832832

833-
The `a2uiClientCapabilities` object in the metadata follows the [`a2ui_client_capabilities.json`] schema.
833+
The `a2uiClientCapabilities` object in the metadata follows the [`client_capabilities.json`] schema.
834834

835835
**Properties:**
836836

@@ -839,7 +839,7 @@ The `a2uiClientCapabilities` object in the metadata follows the [`a2ui_client_ca
839839

840840
#### Client data model
841841

842-
When `sendDataModel` is enabled for a surface, the client includes the `a2uiClientDataModel` object in the metadata, following the [`a2ui_client_data_model.json`] schema.
842+
When `sendDataModel` is enabled for a surface, the client includes the `a2uiClientDataModel` object in the metadata, following the [`client_data_model.json`] schema.
843843

844844
**Properties:**
845845

@@ -854,7 +854,7 @@ This message is used to report a client-side error to the server.
854854
[`server_to_client.json`]: ../json/server_to_client.json
855855
[`client_to_server.json`]: ../json/client_to_server.json
856856
[`server_capabilities.json`]: ../json/server_capabilities.json
857-
[`a2ui_client_capabilities.json`]: ../json/a2ui_client_capabilities.json
858-
[`a2ui_client_data_model.json`]: ../json/a2ui_client_data_model.json
857+
[`client_capabilities.json`]: ../json/client_capabilities.json
858+
[`client_data_model.json`]: ../json/client_data_model.json
859859
[JSON Pointer]: https://datatracker.ietf.org/doc/html/rfc6901
860860
[RFC 6901]: https://datatracker.ietf.org/doc/html/rfc6901

specification/v0_9/json/a2ui_client_capabilities.json renamed to specification/v0_9/json/client_capabilities.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "https://json-schema.org/draft/2020-12/schema",
3-
"$id": "https://a2ui.org/specification/v0_9/a2ui_client_capabilities.json",
3+
"$id": "https://a2ui.org/specification/v0_9/client_capabilities.json",
44
"title": "A2UI Client Capabilities Schema",
55
"description": "A schema for the a2uiClientCapabilities object, which is sent from the client to the server as part of the A2A metadata to describe the client's UI rendering capabilities.",
66
"type": "object",

specification/v0_9/json/a2ui_client_data_model.json renamed to specification/v0_9/json/client_data_model.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "https://json-schema.org/draft/2020-12/schema",
3-
"$id": "https://a2ui.org/specification/v0_9/a2ui_client_data_model.json",
3+
"$id": "https://a2ui.org/specification/v0_9/client_data_model.json",
44
"title": "A2UI Client Data Model Schema",
55
"description": "Schema for attaching the client data model to A2A message metadata. This object should be placed in the `a2uiClientDataModel` field of the metadata.",
66
"type": "object",

0 commit comments

Comments
 (0)