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

add optional units to refuel request

Browse Source
This commit is contained in:
SpaceAdmiral 2023-06-17 08:27:48 -07:00
parent b01b55fd14
commit 7685727af7
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
reference/SpaceTraders.json
View File

@ -2624,6 +2624,23 @@
"post": { "post": {
"description": "Refuel your ship by buying fuel from the local market.\n\nRequires the ship to be docked in a waypoint that has the `Marketplace` trait, and the market must be selling fuel in order to refuel.\n\nEach fuel bought from the market replenishes 100 units in your ship's fuel.\n\nShips will always be refuel to their frame's maximum fuel capacity when using this action.", "description": "Refuel your ship by buying fuel from the local market.\n\nRequires the ship to be docked in a waypoint that has the `Marketplace` trait, and the market must be selling fuel in order to refuel.\n\nEach fuel bought from the market replenishes 100 units in your ship's fuel.\n\nShips will always be refuel to their frame's maximum fuel capacity when using this action.",
"operationId": "refuel-ship", "operationId": "refuel-ship",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"units": {
"type": "integer",
"description": "The amount of fuel to fill in the ship's tanks. When not specified, the ship will be refueled to its maximum fuel capacity. If the amount specified is greater than the ship's remaining capacity, the ship will only be refueled to its maximum fuel capacity. The amount specified is not in market units but in ship fuel units.",
"example": "100",
"minimum": 1
}
}
}
}
}
},
"responses": { "responses": {
"200": { "200": {
"content": { "content": {