From e3a744a94b51d34a6e883a5291ec4085b54e31b0 Mon Sep 17 00:00:00 2001
From: Athanasius <github@miggy.org>
Date: Tue, 27 Sep 2022 14:46:31 +0100
Subject: [PATCH] schemas/navroute: `gameversion` & `gamebuild` in header

---
 schemas/navroute-README.md | 27 +++++++++++++++++++++++++++
 schemas/navroute-v1.0.json | 10 ++++++++++
 2 files changed, 37 insertions(+)

diff --git a/schemas/navroute-README.md b/schemas/navroute-README.md
index 703c794..7315e39 100644
--- a/schemas/navroute-README.md
+++ b/schemas/navroute-README.md
@@ -31,3 +31,30 @@ separate file.
 Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)
 in the Developers' documentation.
 
+#### gameversion
+You **MUST** always add this field **to the header object**.
+
+1. If you are using Journal files directly then you **MUST** use the value
+  of the `gameversion` element from the`Fileheader` event.
+2. If you are using the CAPI `/journal` endpoint to retrieve and process
+  Journal events then:
+   1. You will not have `Fileheader` available.
+   2. If `gameversion` is present in the `LoadGame` event, as in 4.0 clients,
+     use its value.
+   3. If `LoadGame` does not have a `gameversion` element, as with 3.8 Horizons
+     clients (up to at least `3.8.0.407`), you **MUST** set `gameversion`, but 
+     with the value `"CAPI"`.
+
+#### gamebuild
+You **MUST** always add this field **to the header object**.
+
+1. If you are using Journal files directly then you **MUST** use the value
+   of the `build` value from the`Fileheader` event.
+2. If you are using the CAPI `/journal` endpoint to retrieve and process
+   Journal events then:
+    1. You will not have `Fileheader` available.
+    2. If `build` is present in the `LoadGame` event, as in 4.0 clients, use
+      its value.
+    3. If `LoadGame` does not have a `build` element, as with 3.8 Horizons
+       clients (up to at least `3.8.0.407`), you **MUST** set `gamebuild`, but
+       with the value `"CAPI"`.
diff --git a/schemas/navroute-v1.0.json b/schemas/navroute-v1.0.json
index 4a5a83c..f160cd6 100644
--- a/schemas/navroute-v1.0.json
+++ b/schemas/navroute-v1.0.json
@@ -16,6 +16,16 @@
                 "uploaderID": {
                     "type"          : "string"
                 },
+                "gameversion": {
+                    "type"          : "string",
+                    "minLength"     : 1,
+                    "description"   : "From Fileheader event if available, else LoadGame if available there."
+                },
+                "gamebuild": {
+                    "type"          : "string",
+                    "minLength"     : 1,
+                    "description"   : "The `build` value from a Fileheader event if available, else LoadGame if available there."
+                },
                 "softwareName": {
                     "type"          : "string"
                 },