From 6c9986ec58722bb67c759ba47821527d9558db46 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Tue, 27 Sep 2022 14:44:00 +0100 Subject: [PATCH] schemas/fssdiscoveryscan: `gameversion` & `gamebuild` in header --- schemas/fssdiscoveryscan-README.md | 28 ++++++++++++++++++++++++++++ schemas/fssdiscoveryscan-v1.0.json | 10 ++++++++++ 2 files changed, 38 insertions(+) diff --git a/schemas/fssdiscoveryscan-README.md b/schemas/fssdiscoveryscan-README.md index f7c8757..014d44d 100644 --- a/schemas/fssdiscoveryscan-README.md +++ b/schemas/fssdiscoveryscan-README.md @@ -24,6 +24,34 @@ The primary data source for this schema is the ED Journal event 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"`. + #### StarPos You MUST add a `StarPos` array containing the system co-ordinates from the last `FSDJump`, `CarrierJump`, or `Location` event. diff --git a/schemas/fssdiscoveryscan-v1.0.json b/schemas/fssdiscoveryscan-v1.0.json index 9751db1..f007fe0 100644 --- a/schemas/fssdiscoveryscan-v1.0.json +++ b/schemas/fssdiscoveryscan-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" },