diff --git a/schemas/approachsettlement-README.md b/schemas/approachsettlement-README.md index 9dfe6d1..13bfcd7 100644 --- a/schemas/approachsettlement-README.md +++ b/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) diff --git a/schemas/approachsettlement-v1.0.json b/schemas/approachsettlement-v1.0.json index 571db77..b6e5ed8 100644 --- a/schemas/approachsettlement-v1.0.json +++ b/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", diff --git a/scripts/testing/gateway-responses/approachsettlement-ancient_ruins.json b/scripts/testing/gateway-responses/approachsettlement-ancient_ruins.json new file mode 100644 index 0000000..e059145 --- /dev/null +++ b/scripts/testing/gateway-responses/approachsettlement-ancient_ruins.json @@ -0,0 +1,22 @@ +{ + "$schemaRef": "https://eddn.edcd.io/schemas/approachsettlement/1", + "header": { + "uploaderID": "from Athanasius Testing", + "softwareName": "Athanasius Testing script", + "softwareVersion": "v0.0.1" + }, + "message": { + "timestamp": "2022-02-18T15:02:04Z", + "event": "ApproachSettlement", + "Name": "$Ancient:#index=1;", + "SystemAddress": 3515254557027, + "StarSystem": "Synuefe XR-H d11-102", + "BodyID": 13, + "BodyName": "Synuefe XR-H d11-102 1 b", + "Latitude": -46.576923, + "Longitude": 133.985107, + "StarPos": [ + 357.34375, -49.34375, -74.75 + ] + } +} diff --git a/scripts/testing/gateway-responses/approachsettlement-visitor_beacon.json b/scripts/testing/gateway-responses/approachsettlement-visitor_beacon.json new file mode 100644 index 0000000..5656970 --- /dev/null +++ b/scripts/testing/gateway-responses/approachsettlement-visitor_beacon.json @@ -0,0 +1,22 @@ +{ + "$schemaRef": "https://eddn.edcd.io/schemas/approachsettlement/1", + "header": { + "uploaderID": "from Athanasius Testing", + "softwareName": "Athanasius Testing script", + "softwareVersion": "v0.0.1" + }, + "message": { + "timestamp":"2022-02-18T14:33:35Z", + "event":"ApproachSettlement", + "Name":"Battlegroup's Disappearance", + "StarSystem": "Alioth", + "BodyID":8, + "BodyName":"Alioth 1 a", + "Latitude":59.972752, + "Longitude":-84.506294, + "SystemAddress":1109989017963, + "StarPos": [ + -33.65625, 72.46875, -20.65625 + ] + } +}