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

Merge pull request #142 from spansh/codex-entry

Browse Source 
added codexentry event
This commit is contained in:
Athanasius 2021-09-23 19:29:36 +01:00 committed by GitHub
commit 1644b8d975
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 124 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

124
schemas/codexentry-v1.0.json Normal file
View File

@ -0,0 +1,124 @@
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"id" : "https://eddn.edcd.io/schemas/codexentry/1#",
"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"
},
"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",
"minLength" : 1
},
"VoucherAmount": {
"type" : "integer",
},
"Traits": {
"type" : "array",
"items" : {
"type" : "string",
"minLength" : 1
}
},
"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" ] } }
}
}