mirror of
https://github.com/EDCD/EDDN.git
synced 2025-04-12 07:00:04 +03:00
139 lines
5.7 KiB
JSON
139 lines
5.7 KiB
JSON
{
|
|
"$schema" : "http://json-schema.org/draft-04/schema#",
|
|
"id" : "https://eddn.edcd.io/schemas/codexentry/1#",
|
|
"description" : "EDDN schema for CodexEntry Journal events. Full documentation at https://github.com/EDCD/EDDN/tree/master/schemas/codexentry-README.md",
|
|
"type" : "object",
|
|
"additionalProperties" : false,
|
|
"required": [ "$schemaRef", "header", "message" ],
|
|
"properties": {
|
|
"$schemaRef": {
|
|
"type" : "string"
|
|
},
|
|
"header": {
|
|
"type" : "object",
|
|
"additionalProperties" : true,
|
|
"required" : [ "uploaderID", "softwareName", "softwareVersion" ],
|
|
"properties" : {
|
|
"uploaderID": {
|
|
"type" : "string"
|
|
},
|
|
"gameversion": {
|
|
"type" : "string",
|
|
"description" : "From Fileheader event if available, else LoadGame if available there."
|
|
},
|
|
"gamebuild": {
|
|
"type" : "string",
|
|
"description" : "The `build` value from a Fileheader event if available, else LoadGame if available there."
|
|
},
|
|
"softwareName": {
|
|
"type" : "string"
|
|
},
|
|
"softwareVersion": {
|
|
"type" : "string"
|
|
},
|
|
"gatewayTimestamp": {
|
|
"type" : "string",
|
|
"format" : "date-time",
|
|
"description" : "Timestamp upon receipt at the gateway. If present, this property will be overwritten by the gateway; submitters are not intended to populate this property."
|
|
}
|
|
}
|
|
},
|
|
"message": {
|
|
"type" : "object",
|
|
"description" : "Contains all properties from the listed events in the client's journal minus Localised strings and the properties marked below as 'disallowed'",
|
|
"additionalProperties" : false,
|
|
"required" : [ "timestamp", "event", "System", "StarPos", "SystemAddress", "EntryID" ],
|
|
"properties" : {
|
|
"timestamp": {
|
|
"type" : "string",
|
|
"format" : "date-time"
|
|
},
|
|
"event": {
|
|
"enum" : [ "CodexEntry" ]
|
|
},
|
|
"horizons": {
|
|
"type" : "boolean",
|
|
"description" : "Whether the sending Cmdr has a Horizons pass."
|
|
},
|
|
"odyssey": {
|
|
"type" : "boolean",
|
|
"description" : "Whether the sending Cmdr has an Odyssey expansion."
|
|
},
|
|
"System": {
|
|
"type" : "string",
|
|
"minLength" : 1
|
|
},
|
|
"StarPos": {
|
|
"type" : "array",
|
|
"items" : { "type": "number" },
|
|
"minItems" : 3,
|
|
"maxItems" : 3,
|
|
"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"
|
|
},
|
|
"Name": {
|
|
"type" : "string",
|
|
"minLength" : 1
|
|
},
|
|
"Region": {
|
|
"type" : "string",
|
|
"minLength" : 1
|
|
},
|
|
"EntryID": {
|
|
"type" : "integer"
|
|
},
|
|
"Category": {
|
|
"type" : "string",
|
|
"minLength" : 1
|
|
},
|
|
"Latitude": {
|
|
"type" : "number"
|
|
},
|
|
"Longitude": {
|
|
"type" : "number"
|
|
},
|
|
"SubCategory": {
|
|
"type" : "string",
|
|
"minLength" : 1
|
|
},
|
|
"NearestDestination": {
|
|
"type" : "string"
|
|
},
|
|
"VoucherAmount": {
|
|
"type" : "integer"
|
|
},
|
|
"Traits": {
|
|
"type" : "array",
|
|
"items" : {
|
|
"type" : "string",
|
|
"minLength" : 1
|
|
}
|
|
},
|
|
"BodyID": {
|
|
"type" : "integer"
|
|
},
|
|
"BodyName": {
|
|
"type" : "string"
|
|
},
|
|
"IsNewEntry": {
|
|
"$ref" : "#/definitions/disallowed",
|
|
"description" : "Contains personal data"
|
|
},
|
|
"NewTraitsDiscovered": {
|
|
"$ref" : "#/definitions/disallowed",
|
|
"description" : "Contains personal data"
|
|
}
|
|
},
|
|
"patternProperties": {
|
|
"_Localised$" : { "$ref" : "#/definitions/disallowed" }
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"disallowed" : { "not" : { "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }
|
|
}
|
|
}
|