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

approachsettlement/1: Allow MarketID to be optional & document why

Browse Source
This commit is contained in:
Athanasius 2022-02-19 11:29:19 +00:00
parent 8c2a5dca6f
commit 77a2d41d96
No known key found for this signature in database
GPG Key ID: AE3E527847057C7D
2 changed files with 35 additions and 1 deletions

34
schemas/approachsettlement-README.md

@ -19,6 +19,40 @@ discrepancy.**
The primary data source for this schema is the ED Journal event
`ApproachSettlement`.
### MarketID
Whilst the `MarketID` property is not in the required list **YOU MUST
ABSOLUTELY SEND THIS WHEN IT IS PRESENT IN THE SOURCE DATA**.
The only reason it is optional is that there are `ApproachSettlement`
Journal events for things like visitor beacons that do not have a market, and
thus no MarketID.
Examples:
```json
{
"timestamp":"2022-02-18T14:33:35Z",
"event":"ApproachSettlement",
"Name":"Battlegroup's Disappearance",
"SystemAddress":1109989017963,
"BodyID":8,
"BodyName":"Alioth 1 a",
"Latitude":59.972752,
"Longitude":-84.506294
},
{
"timestamp": "2022-02-18T15:02:04Z",
"event": "ApproachSettlement",
"Name": "$Ancient:#index=1;",
"Name_Localised": "Ancient Ruins (1)",
"SystemAddress": 3515254557027,
"BodyID": 13,
"BodyName": "Synuefe XR-H d11-102 1 b",
"Latitude": -46.576923,
"Longitude": 133.985107
},
```
### Augmentations
#### horizons and odyssey flags
Please read [horizons and odyssey flags](../docs/Developers.md#horizons-and-odyssey-flags)

2
schemas/approachsettlement-v1.0.json

@ -33,7 +33,7 @@
"type" : "object",
"description" : "Contains all properties from the listed events in the client's journal minus the Localised strings and the properties marked below as 'disallowed'",
"additionalProperties" : false,
"required" : [ "timestamp", "event", "StarSystem", "StarPos", "SystemAddress", "Name", "MarketID", "BodyID", "BodyName", "Latitude", "Longitude" ],
"required" : [ "timestamp", "event", "StarSystem", "StarPos", "SystemAddress", "Name", "BodyID", "BodyName", "Latitude", "Longitude" ],
"properties" : {
"timestamp": {
"type" : "string",