diff --git a/models/ContractDeliverGood.json b/models/ContractDeliverGood.json index c0a452f..02e1377 100644 --- a/models/ContractDeliverGood.json +++ b/models/ContractDeliverGood.json @@ -2,7 +2,7 @@ "description": "The details of a delivery contract. Includes the type of good, units needed, and the destination.", "type": "object", "properties": { - "symbol": { + "tradeSymbol": { "type": "string", "description": "The symbol of the trade good to deliver.", "minLength": 1 @@ -22,7 +22,7 @@ } }, "required": [ - "symbol", + "tradeSymbol", "destinationSymbol", "unitsRequired", "unitsFulfilled" diff --git a/models/Survey.json b/models/Survey.json index c663875..a9d8837 100644 --- a/models/Survey.json +++ b/models/Survey.json @@ -7,6 +7,11 @@ "description": "A unique signature for the location of this survey. This signature is verified when attempting an extraction using this survey.", "minLength": 1 }, + "symbol": { + "type": "string", + "description": "The symbol of the waypoint that this survey is for.", + "minLength": 1 + }, "deposits": { "type": "array", "description": "A list of deposits that can be found at this location.", @@ -23,6 +28,7 @@ }, "required": [ "signature", + "symbol", "deposits", "expiration" ] diff --git a/reference/SpaceTraders.json b/reference/SpaceTraders.json index 9441c69..d905571 100644 --- a/reference/SpaceTraders.json +++ b/reference/SpaceTraders.json @@ -1275,6 +1275,67 @@ ] } }, + "/my/ships/{shipSymbol}/survey": { + "parameters": [ + { + "description": "The symbol of the ship", + "in": "path", + "name": "shipSymbol", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "description": "If you want to target specific yields for an extraction, you can survey a waypoint, such as an asteroid field, and send the survey in the body of the extract request. Each survey may have multiple deposits, and if a symbol shows up more than once, that indicates a higher chance of extracting that resource.\n\nYour ship will enter a cooldown between consecutive survey requests. Surveys will eventually expire after a period of time. Multiple ships can use the same survey for extraction.", + "operationId": "create-survey", + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "properties": { + "cooldown": { + "$ref": "../models/Cooldown.json" + }, + "surveys": { + "items": { + "$ref": "../models/Survey.json" + }, + "type": "array" + } + }, + "required": [ + "surveys", + "cooldown" + ], + "type": "object" + } + }, + "type": "object", + "required": [ + "data" + ] + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "AgentToken": [] + } + ], + "summary": "Create Survey", + "tags": [ + "fleet" + ] + } + }, "/my/ships/{shipSymbol}/extract": { "parameters": [ { @@ -1288,7 +1349,7 @@ } ], "post": { - "description": "Extract resources from the waypoint into your ship. Send a survey as the payload to target specific yields. The entire survey must be sent as it contains a signature that the backend verifies.", + "description": "Extract resources from the waypoint into your ship. Send an optional survey as the payload to target specific yields.", "operationId": "extract-resources", "requestBody": { "content": { @@ -1299,14 +1360,10 @@ "$ref": "../models/Survey.json" } }, - "required": [ - "survey" - ], "type": "object" } } - }, - "description": "" + } }, "responses": { "201": {