schema: preventing additional properties in A2UI schmae #371
+1
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi,
We suggest to add
"additionalProperties": falsein the schema definition based on https://tour.json-schema.org/content/03-Objects/02-Additional-PropertiesIt allows simpler validation parsing of the A2UI items by the agent before sending them to the renderer. This property will make
jsonschema.validate()raise exceptions on all properties not in the official schema. So, it will make sure that only a list of beginRendering, surfaceUpdate, dataModelUpdate and deleteSurface are sent to the renderer. It will also ensure that only properties existing in official schema are defined for those commands.It has at least 2 positives consequences:
If required, I can also extend this PR to add
"additionalProperties": falsefor each of the commands so that we also avoid unknown properties at this additional level.Cheers,
Didier