feat: add schemas/vspec-node.schema.json — machine-readable vspec node format #920
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,61 @@ | ||||||
| { | ||||||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||||||
| "$id": "https://covesa.github.io/vehicle_signal_specification/schemas/vspec-node.schema.json", | ||||||
| "title": "VSS vspec node", | ||||||
| "description": "A single node in a VSS vspec YAML file.", | ||||||
| "type": "object", | ||||||
| "required": ["type"], | ||||||
| "properties": { | ||||||
| "type": { | ||||||
| "type": "string", | ||||||
| "enum": ["branch", "sensor", "actuator", "attribute"], | ||||||
| "description": "Node kind. branch = non-leaf container; sensor/actuator/attribute = leaf." | ||||||
| }, | ||||||
| "datatype": { | ||||||
| "type": "string", | ||||||
| "description": "Value type for leaf nodes, e.g. float, uint8, string, boolean. Required for sensor/actuator/attribute; not used on branch." | ||||||
| }, | ||||||
| "description": { | ||||||
| "type": "string", | ||||||
| "description": "Human-readable description of the signal or branch." | ||||||
| }, | ||||||
| "unit": { | ||||||
| "type": "string", | ||||||
| "description": "Unit of measure. Should be a value from the VSS unit catalogue (spec/units.yaml)." | ||||||
| }, | ||||||
| "min": { | ||||||
| "description": "Minimum valid value (numeric). Applies to leaf nodes only." | ||||||
|
|
||||||
| }, | ||||||
| "max": { | ||||||
| "description": "Maximum valid value (numeric). Applies to leaf nodes only." | ||||||
|
|
||||||
| }, | ||||||
| "default": { | ||||||
| "description": "Default value for the signal at startup. Type must match datatype." | ||||||
| }, | ||||||
| "comment": { | ||||||
| "type": "string", | ||||||
| "description": "Informative note, not part of the normative definition." | ||||||
| }, | ||||||
| "deprecation": { | ||||||
| "type": "string", | ||||||
| "description": "Non-empty string indicates this node is deprecated; value is the deprecation notice including the version when it was deprecated." | ||||||
| }, | ||||||
| "instances": { | ||||||
| "description": "Instance expansion expression (string or array of strings) for parameterised branches.", | ||||||
| "oneOf": [ | ||||||
| { "type": "string" }, | ||||||
| { "type": "array", "items": { "type": "string" }, "minItems": 1 } | ||||||
| ] | ||||||
| }, | ||||||
| "allowed": { | ||||||
| "type": "array", | ||||||
| "description": "Enumerated allowed values for the signal. Items should match the datatype.", | ||||||
|
Collaborator
There was a problem hiding this comment.
Suggested change
|
||||||
| "minItems": 1 | ||||||
| }, | ||||||
| "pattern": { | ||||||
| "type": "string", | ||||||
| "description": "Regular expression that the signal value must match." | ||||||
| } | ||||||
|
|
||||||
| }, | ||||||
| "additionalProperties": false | ||||||
| } | ||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not know how easy it would be to create a minimal example on how this could be used, that we potentially could execute as part of CI to verify that std catalog and the schema are in sync. I am thinking of something
vspec export yamlorvspec export jsonHave you done any checks like that to verify that the schema works with the current std catalog?