diff --git a/schemas/navbeaconscan-README.md b/schemas/navbeaconscan-README.md index c12e91b..7a3bdd4 100644 --- a/schemas/navbeaconscan-README.md +++ b/schemas/navbeaconscan-README.md @@ -7,19 +7,22 @@ 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 `NavBeaconScan`. -### Elisions -There are no elisions in this schema. - ### 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) +over in the Developers' documentation. #### StarSystem You MUST add a `StarSystem` key/value pair representing the name of the diff --git a/schemas/navbeaconscan-v1.0.json b/schemas/navbeaconscan-v1.0.json index 64d55bf..b40cfa9 100644 --- a/schemas/navbeaconscan-v1.0.json +++ b/schemas/navbeaconscan-v1.0.json @@ -52,7 +52,8 @@ }, "StarSystem": { "type" : "string", - "minLength" : 1 + "minLength" : 1, + "description" : "Should be added by the sender if not present in the journal event" }, "StarPos": { "type" : "array", @@ -63,7 +64,6 @@ }, "SystemAddress": { "type" : "integer", - "description" : "Should be added by the sender if not present in the journal event" }, "NumBodies" : { "type" : "integer"