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

Modified reference/SpaceTraders.yaml

Browse Source
This commit is contained in:
SpaceAdmiral 2022-03-11 18:10:41 -08:00
parent c5822bfab4
commit 28ea2d2ab3
1 changed files with 86 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

181
reference/SpaceTraders.yaml
View File

@ -94,6 +94,7 @@ paths:
frame: string frame: string
reactor: string reactor: string
engine: string engine: string
fuel: 0
modules: modules:
- string - string
mounts: mounts:
@ -151,7 +152,6 @@ paths:
summary: Get your agent details summary: Get your agent details
tags: tags:
- agents - agents
- my
responses: responses:
'200': '200':
description: OK description: OK
@ -225,7 +225,6 @@ paths:
summary: Deliver on Contract summary: Deliver on Contract
tags: tags:
- contracts - contracts
- my
- ships - ships
- deliver - deliver
responses: responses:
@ -266,6 +265,7 @@ paths:
required: required:
- contractId - contractId
- tradeSymbol - tradeSymbol
description: Deliver cargo on a given contract.
'/my/ships/{shipSymbol}/dock': '/my/ships/{shipSymbol}/dock':
parameters: parameters:
- schema: - schema:
@ -277,7 +277,6 @@ paths:
post: post:
summary: Dock Ship summary: Dock Ship
tags: tags:
- my
- ships - ships
- dock - dock
responses: responses:
@ -310,6 +309,7 @@ paths:
operationId: post-my-ships-shipSymbol-dock operationId: post-my-ships-shipSymbol-dock
security: security:
- AgentToken: [] - AgentToken: []
description: Transition your ship from orbit to docked. Consecutive calls to this endpoint will succeed.
'/my/ships/{shipSymbol}/orbit': '/my/ships/{shipSymbol}/orbit':
parameters: parameters:
- schema: - schema:
@ -321,7 +321,6 @@ paths:
post: post:
summary: Orbit Ship summary: Orbit Ship
tags: tags:
- my
- ships - ships
- orbit - orbit
responses: responses:
@ -363,7 +362,6 @@ paths:
post: post:
summary: Jettison Cargo summary: Jettison Cargo
tags: tags:
- my
- ships - ships
- jettison - jettison
responses: responses:
@ -416,7 +414,6 @@ paths:
tags: tags:
- extract - extract
- mining - mining
- my
- ships - ships
- survey - survey
responses: responses:
@ -527,7 +524,6 @@ paths:
- AgentToken: [] - AgentToken: []
tags: tags:
- extract - extract
- my
- ships - ships
'/my/ships/{shipSymbol}/survey': '/my/ships/{shipSymbol}/survey':
parameters: parameters:
@ -540,7 +536,6 @@ paths:
summary: Survey Waypoint summary: Survey Waypoint
tags: tags:
- extract - extract
- my
- ships - ships
responses: responses:
'201': '201':
@ -602,7 +597,9 @@ paths:
type: object type: object
properties: properties:
surveys: surveys:
$ref: ../models/Survey.yaml type: array
items:
$ref: ../models/Survey.yaml
cooldown: cooldown:
$ref: ../models/Cooldown.yaml $ref: ../models/Cooldown.yaml
required: required:
@ -654,7 +651,6 @@ paths:
summary: Survey Cooldown summary: Survey Cooldown
tags: tags:
- extract - extract
- my
- survey - survey
- ships - ships
responses: responses:
@ -690,7 +686,6 @@ paths:
summary: Jump Ship summary: Jump Ship
tags: tags:
- jump - jump
- my
- ships - ships
- navigation - navigation
responses: responses:
@ -777,7 +772,6 @@ paths:
- AgentToken: [] - AgentToken: []
tags: tags:
- jump - jump
- my
- ships - ships
'/my/ships/{shipSymbol}/purchase': '/my/ships/{shipSymbol}/purchase':
parameters: parameters:
@ -790,7 +784,6 @@ paths:
summary: Purchase Cargo summary: Purchase Cargo
tags: tags:
- markets - markets
- my
- purchase - purchase
- ships - ships
- trade - trade
@ -835,7 +828,6 @@ paths:
post: post:
summary: Refuel summary: Refuel
tags: tags:
- my
- ships - ships
- refuel - refuel
responses: responses:
@ -883,7 +875,6 @@ paths:
post: post:
summary: Scan summary: Scan
tags: tags:
- my
- ships - ships
- scan - scan
responses: responses:
@ -1000,88 +991,90 @@ paths:
Success: Success:
value: value:
data: data:
cooldown:
duration: 59
expiration: '2022-03-12T00:42:44.220Z'
ships: ships:
- symbol: COMMERCE_REPUBLIC-0060A0 - symbol: SPACERS_GUILD-65E1BA
registration:
factionSymbol: COMMERCE_REPUBLIC
role: EXCAVATOR
frameSymbol: FRAME_HEAVY_FREIGHTER
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:20:14.725Z'
- symbol: ZANZIBAR_TRIKES-DF0AAF
registration:
factionSymbol: ZANZIBAR_TRIKES
role: HAULER
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:20:00.725Z'
- symbol: ZANZIBAR_TRIKES-9B80BE
registration:
factionSymbol: ZANZIBAR_TRIKES
role: TRANSPORT
frameSymbol: FRAME_TRANSPORT
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:20:06.725Z'
- symbol: COMMERCE_REPUBLIC-117520
registration:
factionSymbol: COMMERCE_REPUBLIC
role: HARVESTER
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:19:55.725Z'
- symbol: SPACERS_GUILD-609AA5
registration: registration:
factionSymbol: SPACERS_GUILD factionSymbol: SPACERS_GUILD
role: HAULER role: EXCAVATOR
frameSymbol: FRAME_FRIGATE frameSymbol: FRAME_LIGHT_FREIGHTER
reactorSymbol: REACTOR_FUSION_I reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:19:38.725Z' expiration: '2022-03-12T00:44:14.222Z'
- symbol: MINERS_COLLECTIVE-7AD322 - symbol: MINERS_COLLECTIVE-C6ACCA
registration: registration:
factionSymbol: MINERS_COLLECTIVE factionSymbol: MINERS_COLLECTIVE
role: EXCAVATOR role: HARVESTER
frameSymbol: FRAME_SHUTTLE frameSymbol: FRAME_INTERCEPTOR
reactorSymbol: REACTOR_FUSION_I reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:19:11.725Z' expiration: '2022-03-12T00:44:38.222Z'
- symbol: ZANZIBAR_TRIKES-AE6D78 - symbol: COMMERCE_REPUBLIC-866DC7
registration: registration:
factionSymbol: ZANZIBAR_TRIKES factionSymbol: COMMERCE_REPUBLIC
role: HAULER
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:20:44.725Z'
- symbol: SPACERS_GUILD-92828B
registration:
factionSymbol: SPACERS_GUILD
role: SURVEYOR role: SURVEYOR
frameSymbol: FRAME_LIGHT_FREIGHTER frameSymbol: FRAME_LIGHT_FREIGHTER
reactorSymbol: REACTOR_FUSION_I reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:20:49.726Z' expiration: '2022-03-12T00:45:21.222Z'
- symbol: ZANZIBAR_TRIKES-B5EAD1 - symbol: SPACERS_GUILD-2B1D01
registration: registration:
factionSymbol: ZANZIBAR_TRIKES factionSymbol: SPACERS_GUILD
role: TRANSPORT role: SURVEYOR
frameSymbol: FRAME_TRANSPORT frameSymbol: FRAME_HEAVY_FREIGHTER
reactorSymbol: REACTOR_FUSION_I reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:20:25.726Z' expiration: '2022-03-12T00:44:53.222Z'
- symbol: ZANZIBAR_TRIKES-6A4E0D - symbol: MINERS_COLLECTIVE-2F238C
registration:
factionSymbol: MINERS_COLLECTIVE
role: HAULER
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-12T00:44:07.222Z'
- symbol: ZANZIBAR_TRIKES-ACF237
registration: registration:
factionSymbol: ZANZIBAR_TRIKES factionSymbol: ZANZIBAR_TRIKES
role: HAULER role: HAULER
frameSymbol: FRAME_INTERCEPTOR
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-12T00:44:22.223Z'
- symbol: SPACERS_GUILD-94A474
registration:
factionSymbol: SPACERS_GUILD
role: EXCAVATOR
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-12T00:43:51.223Z'
- symbol: ZANZIBAR_TRIKES-648BA8
registration:
factionSymbol: ZANZIBAR_TRIKES
role: PATROL
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-12T00:44:56.223Z'
- symbol: COMMERCE_REPUBLIC-1EED24
registration:
factionSymbol: COMMERCE_REPUBLIC
role: PATROL
frameSymbol: FRAME_EXPLORER frameSymbol: FRAME_EXPLORER
reactorSymbol: REACTOR_FUSION_I reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:19:19.726Z' expiration: '2022-03-12T00:45:23.223Z'
cooldown: 60 - symbol: ZANZIBAR_TRIKES-A5600D
registration:
factionSymbol: ZANZIBAR_TRIKES
role: PATROL
frameSymbol: FRAME_FRIGATE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-12T00:44:00.223Z'
operationId: post-my-ships-shipSymbol-scan operationId: post-my-ships-shipSymbol-scan
security: security:
- AgentToken: [] - AgentToken: []
@ -1118,7 +1111,6 @@ paths:
summary: Sell Cargo summary: Sell Cargo
tags: tags:
- markets - markets
- my
- sell - sell
- ships - ships
- trade - trade
@ -1165,7 +1157,6 @@ paths:
post: post:
summary: Navigate ship summary: Navigate ship
tags: tags:
- my
- navigation - navigation
- ships - ships
responses: responses:
@ -1254,7 +1245,6 @@ paths:
security: security:
- AgentToken: [] - AgentToken: []
tags: tags:
- my
- navigation - navigation
- ships - ships
'/my/ships/{shipSymbol}': '/my/ships/{shipSymbol}':
@ -1267,7 +1257,6 @@ paths:
get: get:
summary: View Ship summary: View Ship
tags: tags:
- my
- ships - ships
responses: responses:
'200': '200':
@ -1315,7 +1304,6 @@ paths:
get: get:
summary: List Ships summary: List Ships
tags: tags:
- my
- ships - ships
responses: responses:
'200': '200':
@ -1480,9 +1468,10 @@ paths:
Success: Success:
value: value:
data: data:
- symbol: 653298-1 - symbol: 55B261-1
crew: null crew: null
officers: null officers: null
fuel: 100
frame: FRAME_DRONE frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION engine: ENGINE_SOLAR_PROPULSION
@ -1492,7 +1481,7 @@ paths:
- MOUNT_MINING_LASER_I - MOUNT_MINING_LASER_I
registration: registration:
factionSymbol: COMMERCE_REPUBLIC factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298' agentSymbol: 55B261
fee: 100 fee: 100
role: EXCAVATOR role: EXCAVATOR
integrity: integrity:
@ -1502,9 +1491,10 @@ paths:
status: DOCKED status: DOCKED
location: X1-OE-PM location: X1-OE-PM
cargo: [] cargo: []
- symbol: 653298-2 - symbol: 55B261-2
crew: null crew: null
officers: null officers: null
fuel: 100
frame: FRAME_DRONE frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION engine: ENGINE_SOLAR_PROPULSION
@ -1514,7 +1504,7 @@ paths:
- MOUNT_MINING_LASER_I - MOUNT_MINING_LASER_I
registration: registration:
factionSymbol: COMMERCE_REPUBLIC factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298' agentSymbol: 55B261
fee: 100 fee: 100
role: EXCAVATOR role: EXCAVATOR
integrity: integrity:
@ -1524,9 +1514,10 @@ paths:
status: DOCKED status: DOCKED
location: X1-OE-PM location: X1-OE-PM
cargo: [] cargo: []
- symbol: 653298-3 - symbol: 55B261-3
crew: null crew: null
officers: null officers: null
fuel: 100
frame: FRAME_DRONE frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION engine: ENGINE_SOLAR_PROPULSION
@ -1536,7 +1527,7 @@ paths:
- MOUNT_MINING_LASER_I - MOUNT_MINING_LASER_I
registration: registration:
factionSymbol: COMMERCE_REPUBLIC factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298' agentSymbol: 55B261
fee: 100 fee: 100
role: EXCAVATOR role: EXCAVATOR
integrity: integrity:
@ -1546,9 +1537,10 @@ paths:
status: DOCKED status: DOCKED
location: X1-OE-PM location: X1-OE-PM
cargo: [] cargo: []
- symbol: 653298-4 - symbol: 55B261-4
crew: null crew: null
officers: null officers: null
fuel: 100
frame: FRAME_DRONE frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION engine: ENGINE_SOLAR_PROPULSION
@ -1558,7 +1550,7 @@ paths:
- MOUNT_MINING_LASER_I - MOUNT_MINING_LASER_I
registration: registration:
factionSymbol: COMMERCE_REPUBLIC factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298' agentSymbol: 55B261
fee: 100 fee: 100
role: EXCAVATOR role: EXCAVATOR
integrity: integrity:
@ -1568,9 +1560,10 @@ paths:
status: DOCKED status: DOCKED
location: X1-OE-PM location: X1-OE-PM
cargo: [] cargo: []
- symbol: 653298-5 - symbol: 55B261-5
crew: null crew: null
officers: null officers: null
fuel: 100
frame: FRAME_DRONE frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION engine: ENGINE_SOLAR_PROPULSION
@ -1580,7 +1573,7 @@ paths:
- MOUNT_MINING_LASER_I - MOUNT_MINING_LASER_I
registration: registration:
factionSymbol: COMMERCE_REPUBLIC factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298' agentSymbol: 55B261
fee: 100 fee: 100
role: EXCAVATOR role: EXCAVATOR
integrity: integrity:
@ -1590,9 +1583,10 @@ paths:
status: DOCKED status: DOCKED
location: X1-OE-PM location: X1-OE-PM
cargo: [] cargo: []
- symbol: 653298-6 - symbol: 55B261-6
crew: null crew: null
officers: null officers: null
fuel: 100
frame: FRAME_DRONE frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION engine: ENGINE_SOLAR_PROPULSION
@ -1602,7 +1596,7 @@ paths:
- MOUNT_MINING_LASER_I - MOUNT_MINING_LASER_I
registration: registration:
factionSymbol: COMMERCE_REPUBLIC factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298' agentSymbol: 55B261
fee: 100 fee: 100
role: EXCAVATOR role: EXCAVATOR
integrity: integrity:
@ -1624,7 +1618,6 @@ paths:
get: get:
summary: List Contracts summary: List Contracts
tags: tags:
- my
- contracts - contracts
responses: responses:
'200': '200':
@ -1724,7 +1717,6 @@ paths:
get: get:
summary: View Contract summary: View Contract
tags: tags:
- my
- contracts - contracts
responses: responses:
'200': '200':
@ -1936,7 +1928,6 @@ paths:
security: security:
- AgentToken: [] - AgentToken: []
tags: tags:
- name: my
- name: ships - name: ships
- name: markets - name: markets
- name: trade - name: trade