From 6b213795e529b8fddd69abe51828585da3df0df3 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Sun, 30 Jan 2022 16:54:58 +0000 Subject: [PATCH] schemas/scanbarycentre: Bring in line with current standards --- schemas/scanbarycentre-README.md | 20 +++++++++++++------- schemas/scanbarycentre-v1.0.json | 3 +-- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/schemas/scanbarycentre-README.md b/schemas/scanbarycentre-README.md index da0e178..efe75c5 100644 --- a/schemas/scanbarycentre-README.md +++ b/schemas/scanbarycentre-README.md @@ -7,19 +7,25 @@ Event and properly structure it for sending to EDDN. Please consult [EDDN Schemas README](./README-EDDN-schemas.md) for general documentation for a schema such as this. +If you find any discrepancies between what this document says and what is +defined in the relevant Schema file, then you should, in the first instance, +assume that it is the Schema file that is correct. +**PLEASE open +[an issue on GitHub](https://github.com/EDCD/EDDN/issues/new/choose) +to report any such anomalies you find so that we can check and resolve the +discrepancy.** + ## Senders The primary data source for this schema is the ED Journal event `ScanBaryCentre`. -### Elisions -There are no elisions in this schema. +Although most of the event-specific data is not specified as `required`, +senders SHOULD include any defined in the schema if it's in the source data. ### Augmentations -#### horizons flag -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. +#### horizons and odyssey flags +Please read [horizons and odyssey flags](../../docs/Developers.md#horizons-and-odyssey-flags) +in the Developers' documentation. #### StarPos You MUST add a `StarPos` array containing the system co-ordinates from the diff --git a/schemas/scanbarycentre-v1.0.json b/schemas/scanbarycentre-v1.0.json index 15a8985..e019326 100644 --- a/schemas/scanbarycentre-v1.0.json +++ b/schemas/scanbarycentre-v1.0.json @@ -62,8 +62,7 @@ "description" : "Must be added by the sender if not present in the journal event" }, "SystemAddress": { - "type" : "integer", - "description" : "Should be added by the sender if not present in the journal event" + "type" : "integer" }, "BodyID": { "type" : "integer"