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

update: adds specific /extract/survey endpoint

Browse Source 
deprecation: removing survey property from the /extract endpoint
This commit is contained in:
SpaceAdmiral 2023-09-13 08:58:11 -07:00
parent c11ab9a928
commit 6aa30abb9a
2 changed files with 75 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
models/Survey.json
View File

@ -14,7 +14,7 @@
},
"deposits": {
"type": "array",
"description": "A list of deposits that can be found at this location.",
"description": "A list of deposits that can be found at this location. A ship will extract one of these deposits when using this survey in an extraction request. If multiple deposits of the same type are present, the chance of extracting that deposit is increased.",
"items": {
"$ref": "./SurveyDeposit.json"
}

75
reference/SpaceTraders.json
View File

@ -1983,7 +1983,7 @@
}
],
"post": {
"description": "Extract resources from a waypoint that can be extracted, such as asteroid fields, into your ship. Send an optional survey as the payload to target specific yields.\n\nThe ship must be in orbit to be able to extract and must have mining equipments installed that can extract goods, such as the `Gas Siphon` mount for gas-based goods or `Mining Laser` mount for ore-based goods.",
"description": "Extract resources from a waypoint that can be extracted, such as asteroid fields, into your ship. Send an optional survey as the payload to target specific yields.\n\nThe ship must be in orbit to be able to extract and must have mining equipments installed that can extract goods, such as the `Gas Siphon` mount for gas-based goods or `Mining Laser` mount for ore-based goods.\n\nThe survey property is now deprecated. See the `extract/survey` endpoint for more details.",
"operationId": "extract-resources",
"requestBody": {
"content": {
@ -1991,6 +1991,7 @@
"schema": {
"properties": {
"survey": {
"deprecated": true,
"$ref": "../models/Survey.json"
}
},
@ -2047,6 +2048,78 @@
]
}
},
"/my/ships/{shipSymbol}/extract/survey": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Use a survey when extracting resources from a waypoint. This endpoint requires a survey as the payload, which allows your ship to extract specific yields.\n\nSend the full survey object as the payload which will be validated according to the signature. If the signature is invalid, or any properties of the survey are changed, the request will fail.",
"operationId": "extract-resources-with-survey",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "../models/Survey.json"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"cooldown": {
"$ref": "../models/Cooldown.json"
},
"extraction": {
"$ref": "../models/Extraction.json"
},
"cargo": {
"$ref": "../models/ShipCargo.json"
}
},
"required": [
"extraction",
"cooldown",
"cargo"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Extracted successfully."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Extract Resources with Survey",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/jettison": {
"parameters": [
{