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 2 files

Browse Source
This commit is contained in:
SpaceAdmiral 2022-03-11 17:44:45 -08:00
parent 58bb69768b
commit 8f09683e17
2 changed files with 95 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
models/Jump.yaml Normal file
View File

@ -0,0 +1,19 @@
description: ''
type: object
properties:
shipSymbol:
type: string
minLength: 1
destination:
type: string
minLength: 1
required:
- shipSymbol
- destination
x-examples:
example-1:
shipSymbol: 1D7FDA-1
destination: 00E0B1
examples:
- shipSymbol: 1D7FDA-1
destination: 00E0B1

82
reference/SpaceTraders.yaml
View File

@ -539,7 +539,10 @@ paths:
required: true
post:
summary: Survey a waypoint
tags: []
tags:
- extract
- my
- ships
responses:
'201':
description: Created
@ -687,9 +690,27 @@ paths:
schema:
description: ''
type: object
x-examples:
example-1:
data:
jump:
shipSymbol: 1D7FDA-1
destination: 00E0B1
cooldown:
duration: 719
expiration: '2022-03-12T00:52:56.735Z'
properties:
data:
type: object
required:
- jump
- cooldown
properties:
jump:
type: object
required:
- shipSymbol
- destination
properties:
shipSymbol:
type: string
@ -698,29 +719,55 @@ paths:
type: string
minLength: 1
cooldown:
type: number
required:
- shipSymbol
- destination
- cooldown
$ref: ../models/Cooldown.yaml
required:
- data
x-examples:
example-1:
data:
shipSymbol: CE392B-1
destination: 0b1802ba-da4d-4308-aefb-1e5065f98a53
cooldown: 43200
examples:
Success:
value:
data:
shipSymbol: CE392B-1
destination: 0b1802ba-da4d-4308-aefb-1e5065f98a53
cooldown: 43200
jump:
shipSymbol: 1D7FDA-1
destination: 00E0B1
cooldown:
duration: 719
expiration: '2022-03-12T00:52:56.735Z'
operationId: post-my-ships-shipSymbol-jump
security:
- AgentToken: []
get:
summary: ''
operationId: get-my-ships-shipSymbol-jump
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
cooldown:
duration: 719
expiration: '2022-03-12T00:52:56.735Z'
properties:
data:
type: object
required:
- cooldown
properties:
cooldown:
$ref: ../models/Cooldown.yaml
required:
- data
security:
- AgentToken: []
tags:
- jump
- my
- ships
'/my/ships/{shipSymbol}/purchase':
parameters:
- schema:
@ -1168,7 +1215,10 @@ paths:
description: The ship symbol
post:
summary: Navigate ship
tags: []
tags:
- my
- navigation
- ships
responses:
'201':
description: Created