diff --git a/models/ShipEngine.json b/models/ShipEngine.json index 3a1d032..b5bdb88 100644 --- a/models/ShipEngine.json +++ b/models/ShipEngine.json @@ -5,10 +5,10 @@ "symbol": { "type": "string", "enum": [ - "ENGINE_IMPULSE_DRIVE", + "ENGINE_IMPULSE_DRIVE_I", "ENGINE_ION_DRIVE_I", "ENGINE_ION_DRIVE_II", - "ENGINE_HYPER_DRIVE" + "ENGINE_HYPER_DRIVE_I" ] }, "name": { diff --git a/models/ShipModule.json b/models/ShipModule.json index 916b751..813c9b2 100644 --- a/models/ShipModule.json +++ b/models/ShipModule.json @@ -5,16 +5,19 @@ "symbol": { "type": "string", "enum": [ - "MODULE_MINERAL_PROCESSOR", - "MODULE_CARGO_HOLD", - "MODULE_CREW_QUARTERS", - "MODULE_ENVOY_QUARTERS", - "MODULE_PASSENGER_CABIN", - "MODULE_MICRO_REFINERY", - "MODULE_SCIENCE_LAB", + "MODULE_MINERAL_PROCESSOR_I", + "MODULE_CARGO_HOLD_I", + "MODULE_CREW_QUARTERS_I", + "MODULE_ENVOY_QUARTERS_I", + "MODULE_PASSENGER_CABIN_I", + "MODULE_MICRO_REFINERY_I", + "MODULE_SCIENCE_LAB_I", "MODULE_JUMP_DRIVE_I", "MODULE_JUMP_DRIVE_II", "MODULE_JUMP_DRIVE_III", + "MODULE_WARP_DRIVE_I", + "MODULE_WARP_DRIVE_II", + "MODULE_WARP_DRIVE_III", "MODULE_SHIELD_GENERATOR_I", "MODULE_SHIELD_GENERATOR_II" ] diff --git a/models/ShipType.json b/models/ShipType.json new file mode 100644 index 0000000..0642999 --- /dev/null +++ b/models/ShipType.json @@ -0,0 +1,15 @@ +{ + "description": "", + "type": "string", + "enum": [ + "SHIP_PROBE", + "SHIP_MINING_DRONE", + "SHIP_INTERCEPTOR", + "SHIP_LIGHT_HAULER", + "SHIP_COMMAND_FRIGATE", + "SHIP_EXPLORER", + "SHIP_HEAVY_FREIGHTER", + "SHIP_LIGHT_SHUTTLE", + "SHIP_ORE_HOUND" + ] +} \ No newline at end of file diff --git a/models/ShipyardShip.json b/models/ShipyardShip.json index 3df7d82..6a4819b 100644 --- a/models/ShipyardShip.json +++ b/models/ShipyardShip.json @@ -2,19 +2,8 @@ "description": "", "type": "object", "properties": { - "symbol": { - "type": "string", - "enum": [ - "SHIP_PROBE_SATELLITE", - "SHIP_MINING_DRONE", - "SHIP_INTERCEPTOR", - "SHIP_LIGHT_HAULER", - "SHIP_COMMAND_FRIGATE", - "SHIP_EXPLORER", - "SHIP_HEAVY_FREIGHTER", - "SHIP_LIGHT_SHUTTLE", - "SHIP_ORE_HOUND" - ] + "type": { + "$ref": "./ShipType.json" }, "name": { "type": "string" diff --git a/models/TradeGood.json b/models/TradeGood.json index 62f5c9d..e7224e6 100644 --- a/models/TradeGood.json +++ b/models/TradeGood.json @@ -76,17 +76,17 @@ "REACTOR_FISSION_I", "REACTOR_CHEMICAL_I", "REACTOR_ANTIMATTER_I", - "ENGINE_IMPULSE_DRIVE", + "ENGINE_IMPULSE_DRIVE_I", "ENGINE_ION_DRIVE_I", "ENGINE_ION_DRIVE_II", - "ENGINE_HYPER_DRIVE", - "MODULE_MINERAL_PROCESSOR", - "MODULE_CARGO_HOLD", - "MODULE_CREW_QUARTERS", - "MODULE_ENVOY_QUARTERS", - "MODULE_PASSENGER_CABIN", - "MODULE_MICRO_REFINERY", - "MODULE_SCIENCE_LAB", + "ENGINE_HYPER_DRIVE_I", + "MODULE_MINERAL_PROCESSOR_I", + "MODULE_CARGO_HOLD_I", + "MODULE_CREW_QUARTERS_I", + "MODULE_ENVOY_QUARTERS_I", + "MODULE_PASSENGER_CABIN_I", + "MODULE_MICRO_REFINERY_I", + "MODULE_SCIENCE_LAB_I", "MODULE_JUMP_DRIVE_I", "MODULE_JUMP_DRIVE_II", "MODULE_JUMP_DRIVE_III", diff --git a/reference/SpaceTraders.json b/reference/SpaceTraders.json index 3be2869..493a185 100644 --- a/reference/SpaceTraders.json +++ b/reference/SpaceTraders.json @@ -970,9 +970,8 @@ "application/json": { "schema": { "properties": { - "shipSymbol": { - "description": "The symbol of the ship you want to purchase.", - "type": "string" + "shipType": { + "$ref": "../models/ShipType.json" }, "waypointSymbol": { "description": "The symbol of the waypoint you want to purchase the ship at.", @@ -980,7 +979,7 @@ } }, "required": [ - "shipSymbol", + "shipType", "waypointSymbol" ], "type": "object" @@ -1511,7 +1510,7 @@ } ], "post": { - "description": "Jump your ship from one system to another.", + "description": "Jump your ship instantly to a target system. Unlike other forms of navigation, jumping requires a unit of antimatter.", "operationId": "jump-ship", "requestBody": { "content": { @@ -1588,7 +1587,7 @@ } ], "post": { - "description": "Navigate to a target destination. The destination must be located within the same system as the ship. Navigating will consume the necessary fuel and supplies from the ship's manifest, and will pay out crew wages from the agent's account.\n\nThe returned response will detail the route information including the expected time of arrival. Most ship actions are unavailable until the ship has arrived at it's destination.\n\nFor faster-than-light travel between systems, see the ship's jump action.", + "description": "Navigate to a target destination. The destination must be located within the same system as the ship. Navigating will consume the necessary fuel and supplies from the ship's manifest, and will pay out crew wages from the agent's account.\n\nThe returned response will detail the route information including the expected time of arrival. Most ship actions are unavailable until the ship has arrived at it's destination.\n\nTo travel between systems, see the ship's warp or jump actions.", "operationId": "navigate-ship", "requestBody": { "content": { @@ -1653,6 +1652,83 @@ ] } }, + "/my/ships/{shipSymbol}/warp": { + "parameters": [ + { + "in": "path", + "name": "shipSymbol", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "description": "Warp your ship to a target destination in another system. Warping will consume the necessary fuel and supplies from the ship's manifest, and will pay out crew wages from the agent's account.\n\nThe returned response will detail the route information including the expected time of arrival. Most ship actions are unavailable until the ship has arrived at it's destination.", + "operationId": "warp-ship", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "waypointSymbol": { + "description": "The target destination.", + "type": "string" + } + }, + "required": [ + "waypointSymbol" + ], + "type": "object" + } + } + }, + "description": "" + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "properties": { + "fuel": { + "$ref": "../models/ShipFuel.json" + }, + "nav": { + "$ref": "../models/ShipNav.json" + } + }, + "required": [ + "nav", + "fuel" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "The successful transit information including the route details and changes to ship fuel, supplies, and crew wages paid. The route includes the expected time of arrival." + } + }, + "security": [ + { + "AgentToken": [] + } + ], + "summary": "Warp Ship", + "tags": [ + "fleet" + ] + } + }, "/my/ships/{shipSymbol}/sell": { "parameters": [ {