Merge pull request #136 from CDOT-CV/fix/schema-version-update

Update the schema version to 8 for the output messages
CDOT-CV · Dec 31, 2024 · 9ab6086 · 9ab6086
2 parents db4b514 + b0ed4a0
commit 9ab6086
Show file tree

Hide file tree

Showing 64 changed files with 726 additions and 673 deletions.
diff --git a/docs/schemas/README.md b/docs/schemas/README.md
@@ -12,6 +12,8 @@ The jpo-ode supports receiving and decoding ASN1 messages from RSUs. The support
 
 The output JSON of the ODE is complex but it is similar to the official standard of J2735 with some minor differences due to the form of their deserialized POJOs. To help implement proper data validation for the JSON output of the ODE into any data pipeline infrastructure, you may use the provided validation schemas within this directory.
 
+Each jpo-ode output object also contains a `schemaVersion`. This value represents the version of the jpo-ode output that the object came from. This version is not intended to be changed except in the scenario of newly added breaking changes to the output. This value is set [here](./jpo-ode-core/src/main/java/us/dot/its/jpo/ode/model/OdeMsgMetadata.java).
+
 ## Testing the schemas
 These schemas can be used for manual validation in the following steps:
 1. To perform a simple schema validation check against output JSON data from the jpo-ode, you may use a schema validation site such as https://www.jsonschemavalidator.net.