Skip to content

Commit a46d675

Browse files
space-admiralspace-admiral
authored
V2.1 (#74)
* update: new traits and add modifiers * breaking: jump gates and construction * update: add supply to shipyard listing * add gas siphon endpoint * add cooldown to jumps * add missing types * update supply and activity levels * update: add waypoint query filters for type and traits * add cargo modules * add shipyard activity
1 parent efd9094 commit a46d675

17 files changed

+433
-33
lines changed

‎models/ActivityLevel.json‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"type": "string",
3+
"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.",
4+
"enum": [
5+
"WEAK",
6+
"GROWING",
7+
"STRONG"
8+
]
9+
}

‎models/Construction.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"type": "object",
3+
"description": "The construction details of a waypoint.",
4+
"properties": {
5+
"symbol": {
6+
"type": "string",
7+
"description": "The symbol of the waypoint."
8+
},
9+
"materials": {
10+
"type": "array",
11+
"description": "The materials required to construct the waypoint.",
12+
"items": {
13+
"$ref": "./ConstructionMaterial.json"
14+
}
15+
},
16+
"isComplete": {
17+
"type": "boolean",
18+
"description": "Whether the waypoint has been constructed."
19+
}
20+
},
21+
"required": [
22+
"symbol",
23+
"materials",
24+
"isComplete"
25+
]
26+
}

‎models/ConstructionMaterial.json‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"description": "The details of the required construction materials for a given waypoint under construction.",
3+
"type": "object",
4+
"properties": {
5+
"tradeSymbol": {
6+
"$ref": "./TradeSymbol.json"
7+
},
8+
"required": {
9+
"type": "integer",
10+
"description": "The number of units required."
11+
},
12+
"fulfilled": {
13+
"type": "integer",
14+
"description": "The number of units fulfilled toward the required amount."
15+
}
16+
},
17+
"required": [
18+
"tradeSymbol",
19+
"required",
20+
"fulfilled"
21+
]
22+
}

‎models/JumpGate.json‎

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,16 @@
22
"type": "object",
33
"description": "",
44
"properties": {
5-
"jumpRange": {
6-
"type": "number",
7-
"description": "The maximum jump range of the gate."
8-
},
9-
"factionSymbol": {
10-
"type": "string",
11-
"description": "The symbol of the faction that owns the gate."
12-
},
13-
"connectedSystems": {
5+
"connections": {
146
"type": "array",
15-
"description": "The systems within range of the gate that have a corresponding gate.",
7+
"description": "All the gates that are connected to this waypoint.",
168
"items": {
17-
"$ref": "./ConnectedSystem.json"
9+
"type": "string",
10+
"description": "The symbol of the waypoint that has a corresponding gate."
1811
}
1912
}
2013
},
2114
"required": [
22-
"jumpRange",
23-
"connectedSystems"
15+
"connections"
2416
]
2517
}

‎models/MarketTradeGood.json‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,25 @@
55
"type": "string",
66
"description": "The symbol of the trade good."
77
},
8+
"type": {
9+
"type": "string",
10+
"description": "The type of trade good (export, import, or exchange).",
11+
"enum": [
12+
"EXPORT",
13+
"IMPORT",
14+
"EXCHANGE"
15+
]
16+
},
817
"tradeVolume": {
918
"type": "integer",
10-
"description": "The typical volume flowing through the market for this type of good. The larger the trade volume, the more stable prices will be.",
19+
"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.",
1120
"minimum": 1
1221
},
1322
"supply": {
14-
"type": "string",
15-
"description": "A rough estimate of the total supply of this good in the marketplace.",
16-
"enum": [
17-
"SCARCE",
18-
"LIMITED",
19-
"MODERATE",
20-
"ABUNDANT"
21-
]
23+
"$ref": "./SupplyLevel.json"
24+
},
25+
"activity": {
26+
"$ref": "./ActivityLevel.json"
2227
},
2328
"purchasePrice": {
2429
"type": "integer",
@@ -33,6 +38,7 @@
3338
},
3439
"required": [
3540
"symbol",
41+
"type",
3642
"tradeVolume",
3743
"supply",
3844
"purchasePrice",

‎models/ShipModule.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66
"type": "string",
77
"enum": [
88
"MODULE_MINERAL_PROCESSOR_I",
9+
"MODULE_GAS_PROCESSOR_I",
910
"MODULE_CARGO_HOLD_I",
11+
"MODULE_CARGO_HOLD_II",
12+
"MODULE_CARGO_HOLD_III",
1013
"MODULE_CREW_QUARTERS_I",
1114
"MODULE_ENVOY_QUARTERS_I",
1215
"MODULE_PASSENGER_CABIN_I",

‎models/ShipType.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@
44
"enum": [
55
"SHIP_PROBE",
66
"SHIP_MINING_DRONE",
7+
"SHIP_SIPHON_DRONE",
78
"SHIP_INTERCEPTOR",
89
"SHIP_LIGHT_HAULER",
910
"SHIP_COMMAND_FRIGATE",
1011
"SHIP_EXPLORER",
1112
"SHIP_HEAVY_FREIGHTER",
1213
"SHIP_LIGHT_SHUTTLE",
1314
"SHIP_ORE_HOUND",
14-
"SHIP_REFINING_FREIGHTER"
15+
"SHIP_REFINING_FREIGHTER",
16+
"SHIP_SURVEYOR"
1517
]
1618
}

‎models/ShipyardShip.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@
1111
"description": {
1212
"type": "string"
1313
},
14+
"supply": {
15+
"$ref": "./SupplyLevel.json"
16+
},
17+
"activity": {
18+
"$ref": "./ActivityLevel.json"
19+
},
1420
"purchasePrice": {
1521
"type": "integer"
1622
},
@@ -55,6 +61,7 @@
5561
"symbol",
5662
"name",
5763
"description",
64+
"supply",
5865
"purchasePrice",
5966
"frame",
6067
"reactor",

‎models/Siphon.json‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"description": "Siphon details.",
3+
"type": "object",
4+
"properties": {
5+
"shipSymbol": {
6+
"type": "string",
7+
"minLength": 1,
8+
"description": "Symbol of the ship that executed the siphon."
9+
},
10+
"yield": {
11+
"$ref": "./SiphonYield.json",
12+
"description": "Yields from the siphon operation."
13+
}
14+
},
15+
"required": [
16+
"shipSymbol",
17+
"yield"
18+
]
19+
}

‎models/SiphonYield.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"type": "object",
3+
"description": "A yield from the siphon operation.",
4+
"properties": {
5+
"symbol": {
6+
"$ref": "./TradeSymbol.json",
7+
"description": "Symbol of the good that was siphoned."
8+
},
9+
"units": {
10+
"type": "integer",
11+
"description": "The number of units siphoned that were placed into the ship's cargo hold."
12+
}
13+
},
14+
"required": [
15+
"symbol",
16+
"units"
17+
]
18+
}

0 commit comments

Comments
 (0)