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-10 18:54:21 -08:00
parent 58a96dc329
commit 99b79cb237
1 changed files with 84 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

168
reference/SpaceTraders.yaml
View File

@ -19,7 +19,7 @@ info:
```json http ```json http
{ {
"method": "GET", "method": "GET",
"url": "https://v2-0-0.alpha.spacetraders.io/status", "url": "https://v2-0-0.alpha.spacetraders.io",
} }
``` ```
servers: servers:
@ -961,6 +961,89 @@ paths:
description: Sell cargo from your ship's hold to the local market. description: Sell cargo from your ship's hold to the local market.
security: security:
- AgentToken: [] - AgentToken: []
'/my/ships/{shipSymbol}/navigate':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
description: The ship symbol
post:
summary: Navigate ship
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: object
properties:
shipSymbol:
type: string
minLength: 1
departure:
type: string
minLength: 1
destination:
type: string
minLength: 1
durationRemaining:
type: number
arrivedAt: {}
required:
- shipSymbol
- departure
- destination
- durationRemaining
required:
- data
x-examples:
example-1:
data:
shipSymbol: 3AE434-1
departure: X1-OE-PM
destination: X1-OE-A005
durationRemaining: 2159
arrivedAt: null
examples:
Success:
value:
data:
shipSymbol: 3AE434-1
departure: X1-OE-PM
destination: X1-OE-A005
durationRemaining: 2159
arrivedAt: null
operationId: post-my-ships-shipSymbol-navigate
requestBody:
content:
application/json:
schema:
type: object
properties:
destination:
type: string
description: The waypoint symbol to navigate to.
get:
summary: ''
operationId: get-my-ships-shipSymbol-navigate
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties: {}
description: Get the status of your last navigation.
security:
- AgentToken: []
'/my/ships/{shipSymbol}': '/my/ships/{shipSymbol}':
parameters: parameters:
- schema: - schema:
@ -1520,89 +1603,6 @@ paths:
description: Return a list of all systems. description: Return a list of all systems.
security: security:
- AgentToken: [] - AgentToken: []
'/my/ships/{shipSymbol}/navigate':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
description: The ship symbol
post:
summary: Navigate ship
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: object
properties:
shipSymbol:
type: string
minLength: 1
departure:
type: string
minLength: 1
destination:
type: string
minLength: 1
durationRemaining:
type: number
arrivedAt: {}
required:
- shipSymbol
- departure
- destination
- durationRemaining
required:
- data
x-examples:
example-1:
data:
shipSymbol: 3AE434-1
departure: X1-OE-PM
destination: X1-OE-A005
durationRemaining: 2159
arrivedAt: null
examples:
Success:
value:
data:
shipSymbol: 3AE434-1
departure: X1-OE-PM
destination: X1-OE-A005
durationRemaining: 2159
arrivedAt: null
operationId: post-my-ships-shipSymbol-navigate
requestBody:
content:
application/json:
schema:
type: object
properties:
destination:
type: string
description: The waypoint symbol to navigate to.
get:
summary: ''
operationId: get-my-ships-shipSymbol-navigate
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties: {}
description: Get the status of your last navigation.
security:
- AgentToken: []
tags: tags:
- name: my - name: my
- name: ships - name: ships