spacetraders/api-docs
1
0
Fork 0
mirror of https://github.com/SpaceTradersAPI/api-docs.git synced 2024-11-14 22:30:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

update supply and activity levels

Browse Source
This commit is contained in:
SpaceAdmiral 2023-10-25 17:27:37 -07:00
parent 268a1c2442
commit bead15176e
4 changed files with 39 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
models/ActivityLevel.json Normal file
View File

@ -0,0 +1,9 @@
{
"type": "string",
"description": "The activity level of a trade good. If the good is an import, this represents how strong consumption is for the good. If the good is an export, this represents how strong the production is for the good.",
"enum": [
"WEAK",
"GROWING",
"STRONG"
]
}

24
models/MarketTradeGood.json
View File

@ -5,20 +5,25 @@
"type": "string", "type": "string",
"description": "The symbol of the trade good." "description": "The symbol of the trade good."
}, },
"type": {
"type": "string",
"description": "The type of trade good (export, import, or exchange).",
"enum": [
"EXPORT",
"IMPORT",
"EXCHANGE"
]
},
"tradeVolume": { "tradeVolume": {
"type": "integer", "type": "integer",
"description": "The typical volume flowing through the market for this type of good. The larger the trade volume, the more stable prices will be.", "description": "This is the maximum number of units that can be purchased or sold at this market in a single trade for this good. Trade volume also gives an indication of price volatility. A market with a low trade volume will have large price swings, while high trade volume will be more resilient to price changes.",
"minimum": 1 "minimum": 1
}, },
"supply": { "supply": {
"type": "string", "$ref": "./SupplyLevel.json"
"description": "A rough estimate of the total supply of this good in the marketplace.", },
"enum": [ "activity": {
"SCARCE", "$ref": "./ActivityLevel.json"
"LIMITED",
"MODERATE",
"ABUNDANT"
]
}, },
"purchasePrice": { "purchasePrice": {
"type": "integer", "type": "integer",
@ -33,6 +38,7 @@
}, },
"required": [ "required": [
"symbol", "symbol",
"type",
"tradeVolume", "tradeVolume",
"supply", "supply",
"purchasePrice", "purchasePrice",

12
models/ShipyardShip.json
View File

@ -12,14 +12,10 @@
"type": "string" "type": "string"
}, },
"supply": { "supply": {
"type": "string", "$ref": "./SupplyLevel.json"
"description": "A rough estimate of the total supply of this good in the marketplace.", },
"enum": [ "production": {
"SCARCE", "$ref": "./ActivityLevel.json"
"LIMITED",
"MODERATE",
"ABUNDANT"
]
}, },
"purchasePrice": { "purchasePrice": {
"type": "integer" "type": "integer"

11
models/SupplyLevel.json Normal file
View File

@ -0,0 +1,11 @@
{
"type": "string",
"description": "The supply level of a trade good.",
"enum": [
"SCARCE",
"LIMITED",
"MODERATE",
"HIGH",
"ABUNDANT"
]
}