Skip to content

Commit

Permalink
New schema for commodities
Browse files Browse the repository at this point in the history
Report commodities using FDev Companion API names instead of English
names.

Report additional useful info from the Companion API:
- meanPrice
- statusFlags
- additional stockBracket and demandBracket values
  • Loading branch information
Marginal committed Aug 2, 2016
1 parent eb7f3b1 commit 8719225
Showing 1 changed file with 106 additions and 0 deletions.
106 changes: 106 additions & 0 deletions schemas/commodity-v3.0.json
@@ -0,0 +1,106 @@
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"id" : "http://schemas.elite-markets.net/eddn/commodity/3#",
"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",
"additionalProperties" : false,
"required" : [ "systemName", "stationName", "timestamp", "commodities" ],
"properties" : {
"systemName": {
"type" : "string",
"minLength" : 1
},
"stationName": {
"type" : "string",
"minLength" : 1
},
"timestamp": {
"type" : "string",
"format" : "date-time"
},
"commodities": {
"type" : "array",
"minItems" : 1,
"items" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "name", "meanPrice", "buyPrice", "stock", "stockBracket", "sellPrice", "demand", "demandBracket" ],
"properties" : {
"name": {
"type" : "string",
"minLength" : 1,
"description" : "Commodity name as returned by the Companion API, misspellings and all"
},
"meanPrice": {
"type" : "integer"
},
"buyPrice": {
"type" : "integer",
"description" : "Price to buy from the market"
},
"stock": {
"type" : "integer"
},
"stockBracket": {
"$ref" : "#/definitions/levelType"
},
"sellPrice": {
"type" : "integer",
"description" : "Price to sell to the market"
},
"demand": {
"type" : "integer"
},
"demandBracket": {
"$ref" : "#/definitions/levelType"
},
"statusFlags": {
"type" : "array",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"minLength" : 1
}
}
}
}
}
}
}
},
"definitions": {
"levelType": {
"enum" : [0, 1, 2, 3, ""],
"description" : "Note: A value of \"\" indicates that the commodity is not normally sold/purchased at this station, but is currently temporarily for sale/purchase"
}
}
}

0 comments on commit 8719225

Please sign in to comment.