third-party-mirrors/EDDN
1
0
Fork 0
mirror of https://github.com/EDCD/EDDN.git synced 2025-04-22 19:40:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

schemas/navbeaconscan: Bring in line with current standards

Browse Source
This commit is contained in:
Athanasius 2022-01-30 16:13:56 +00:00
parent c73b3d6e08
commit adcf6b6010
No known key found for this signature in database
GPG Key ID: AE3E527847057C7D
2 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
schemas/navbeaconscan-README.md
View File

@ -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

4
schemas/navbeaconscan-v1.0.json
View File

@ -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"