From fa9e17138172c615ab85f191f5cc0ef12af0ee18 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Tue, 27 Sep 2022 14:44:44 +0100 Subject: [PATCH] schemas/fsssignaldiscovered: `gameversion` & `gamebuild` in header --- schemas/fsssignaldiscovered-README.md | 28 +++++++++++++++++++++++++++ schemas/fsssignaldiscovered-v1.0.json | 10 ++++++++++ 2 files changed, 38 insertions(+) diff --git a/schemas/fsssignaldiscovered-README.md b/schemas/fsssignaldiscovered-README.md index ddbb9aa..6aab328 100644 --- a/schemas/fsssignaldiscovered-README.md +++ b/schemas/fsssignaldiscovered-README.md @@ -87,6 +87,34 @@ You SHOULD add this key/value pair, using the value from the `LoadGame` event. #### odyssey flag You SHOULD add this key/value pair, using the value from the `LoadGame` event. +#### 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"`. + #### StarSystem You **MUST** add a `StarSystem` string containing the system name from the last tracked location. You **MUST** cross-check each `FSSSignalDiscovered` diff --git a/schemas/fsssignaldiscovered-v1.0.json b/schemas/fsssignaldiscovered-v1.0.json index 18f8fef..0e30eaf 100644 --- a/schemas/fsssignaldiscovered-v1.0.json +++ b/schemas/fsssignaldiscovered-v1.0.json @@ -17,6 +17,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" },