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

Modified reference/SpaceTraders.yaml

Browse Source
This commit is contained in:
SpaceAdmiral 2022-03-13 17:10:22 -07:00
parent f67c2ba86c
commit dd0d3a8e20
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
reference/SpaceTraders.yaml
View File

@ -416,8 +416,6 @@ paths:
description: The ship symbol description: The ship symbol
post: post:
summary: Extract Resources summary: Extract Resources
tags:
- ships
responses: responses:
'201': '201':
description: Created description: Created
@ -487,6 +485,8 @@ paths:
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 a survey as the payload to target specific yields. The entire survey must be sent as it contains a signature that the backend verifies.
security: security:
- AgentToken: [] - AgentToken: []
tags:
- extract
get: get:
summary: Extraction Cooldown summary: Extraction Cooldown
operationId: get-my-ships-shipSymbol-extract operationId: get-my-ships-shipSymbol-extract
@ -525,7 +525,7 @@ paths:
security: security:
- AgentToken: [] - AgentToken: []
tags: tags:
- mining - extract
'/my/ships/{shipSymbol}/survey': '/my/ships/{shipSymbol}/survey':
parameters: parameters:
- schema: - schema:
@ -535,8 +535,6 @@ paths:
required: true required: true
post: post:
summary: Survey Waypoint summary: Survey Waypoint
tags:
- ships
responses: responses:
'201': '201':
description: Created description: Created
@ -651,10 +649,12 @@ paths:
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. 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.
Your 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. Your 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.
tags:
- extract
get: get:
summary: Survey Cooldown summary: Survey Cooldown
tags: tags:
- ships - extract
responses: responses:
'200': '200':
description: OK description: OK