a2ui-project / a2ui-project/a2ui
[DOCS]: a2uiClientCapabilities format in v0.9 documentation and schema
- Vorherrschende Sprache
- TypeScript
- Sterne
- 16.4k
- Forks
- 1.3k
- Ø Merge
- 3 T. 15 Std.
- Gemergte PRs (30 T.)
- 134
Beschreibung
- [ ] I have searched the existing issues to make sure this documentation issue has not already been reported.
## Problem Page(s)
- `specification/v0_9_1/json/client_capabilities.json`
- https://a2ui.org/concepts/catalogs/#step-2-client-advertises-its-support-catalogs-required
- https://a2ui.org/concepts/actions/#advertising-capabilities
## Describe the Issue
I am validating `a2uiClientCapabilities` against the v0.9 schema, but the formats differ.
The schema and Actions documentation show:
```json
{
"v0.9": {
"supportedCatalogIds": ["..."]
}
}
```
The Catalogs documentation shows:
```json
{
"a2uiClientCapabilities": {
"supportedCatalogIds": ["..."]
}
}
```
Would love some clarity whether the `"v0.9"` wrapper is required.
## Proposed Changes
Update the schema and documentation examples to consistently show the canonical format and remove the trailing comma.
## Additional Context
This prevents clients from reliably validating the documented payload.
Beitragsleitfaden
Rechercherichtung
Das Issue verweist auf drei Stellen: die Schemadatei unter specification/v0_9_1/json/client_capabilities.json und zwei Dokumentationsseiten. Vergleiche die Beispiele, um die Abweichung zwischen dem Wrapper 'v0.9' und dem Schlüssel 'a2uiClientCapabilities' zu erkennen. Aktualisiere Schema und Dokumentation so, dass sie dem kanonischen Format entsprechen, und stelle sicher, dass nachgestellte Kommas entfernt werden. Überprüfe die Änderungen, indem du die JSON-Syntax und die Konsistenz über alle Dateien hinweg kontrollierst.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- json, typescript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Aktiv
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 85/100