mirror of
https://github.com/SpaceTradersAPI/api-docs.git
synced 2024-11-14 22:30:51 +01:00
Modified 3 files
This commit is contained in:
parent
aef59ec6cc
commit
2e540a242f
18
models/Cooldown.yaml
Normal file
18
models/Cooldown.yaml
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
description: ''
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
duration:
|
||||||
|
type: number
|
||||||
|
expiration:
|
||||||
|
type: string
|
||||||
|
minLength: 1
|
||||||
|
required:
|
||||||
|
- duration
|
||||||
|
- expiration
|
||||||
|
x-examples:
|
||||||
|
example-1:
|
||||||
|
duration: 119
|
||||||
|
expiration: '2022-03-12T00:41:29.285Z'
|
||||||
|
examples:
|
||||||
|
- duration: 119
|
||||||
|
expiration: '2022-03-12T00:41:29.285Z'
|
31
models/Extraction.yaml
Normal file
31
models/Extraction.yaml
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
description: ''
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
shipSymbol:
|
||||||
|
type: string
|
||||||
|
minLength: 1
|
||||||
|
yield:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
tradeSymbol:
|
||||||
|
type: string
|
||||||
|
minLength: 1
|
||||||
|
units:
|
||||||
|
type: number
|
||||||
|
required:
|
||||||
|
- tradeSymbol
|
||||||
|
- units
|
||||||
|
required:
|
||||||
|
- shipSymbol
|
||||||
|
- yield
|
||||||
|
x-examples:
|
||||||
|
example-1:
|
||||||
|
shipSymbol: 4B902A-1
|
||||||
|
yield:
|
||||||
|
tradeSymbol: SILICON
|
||||||
|
units: 16
|
||||||
|
examples:
|
||||||
|
- shipSymbol: 4B902A-1
|
||||||
|
yield:
|
||||||
|
tradeSymbol: SILICON
|
||||||
|
units: 16
|
@ -428,49 +428,42 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
description: ''
|
description: ''
|
||||||
type: object
|
type: object
|
||||||
properties:
|
|
||||||
data:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
shipSymbol:
|
|
||||||
type: string
|
|
||||||
minLength: 1
|
|
||||||
cooldown:
|
|
||||||
type: number
|
|
||||||
yield:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
tradeSymbol:
|
|
||||||
type: string
|
|
||||||
minLength: 1
|
|
||||||
units:
|
|
||||||
type: number
|
|
||||||
required:
|
|
||||||
- tradeSymbol
|
|
||||||
- units
|
|
||||||
required:
|
|
||||||
- shipSymbol
|
|
||||||
- cooldown
|
|
||||||
- yield
|
|
||||||
required:
|
|
||||||
- data
|
|
||||||
x-examples:
|
x-examples:
|
||||||
example-1:
|
example-1:
|
||||||
data:
|
data:
|
||||||
shipSymbol: 054A8F-1
|
extraction:
|
||||||
cooldown: 30
|
shipSymbol: 4B902A-1
|
||||||
yield:
|
yield:
|
||||||
tradeSymbol: SILICON
|
tradeSymbol: SILICON
|
||||||
units: 14
|
units: 16
|
||||||
|
cooldown:
|
||||||
|
duration: 119
|
||||||
|
expiration: '2022-03-12T00:41:29.371Z'
|
||||||
|
properties:
|
||||||
|
data:
|
||||||
|
type: object
|
||||||
|
required:
|
||||||
|
- extraction
|
||||||
|
- cooldown
|
||||||
|
properties:
|
||||||
|
extraction:
|
||||||
|
$ref: ../models/Extraction.yaml
|
||||||
|
cooldown:
|
||||||
|
$ref: ../models/Cooldown.yaml
|
||||||
|
required:
|
||||||
|
- data
|
||||||
examples:
|
examples:
|
||||||
Success:
|
Success:
|
||||||
value:
|
value:
|
||||||
data:
|
data:
|
||||||
shipSymbol: 054A8F-1
|
extraction:
|
||||||
cooldown: 30
|
shipSymbol: 4B902A-1
|
||||||
yield:
|
yield:
|
||||||
tradeSymbol: IRON_ORE
|
tradeSymbol: SILICON
|
||||||
units: 14
|
units: 16
|
||||||
|
cooldown:
|
||||||
|
duration: 119
|
||||||
|
expiration: '2022-03-12T00:41:29.371Z'
|
||||||
operationId: post-my-ships-shipSymbol-extract
|
operationId: post-my-ships-shipSymbol-extract
|
||||||
requestBody:
|
requestBody:
|
||||||
content:
|
content:
|
||||||
@ -507,52 +500,36 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
description: ''
|
description: ''
|
||||||
type: object
|
type: object
|
||||||
properties:
|
|
||||||
data:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
shipSymbol:
|
|
||||||
type: string
|
|
||||||
minLength: 1
|
|
||||||
cooldown:
|
|
||||||
type: number
|
|
||||||
yield:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
tradeSymbol:
|
|
||||||
type: string
|
|
||||||
minLength: 1
|
|
||||||
units:
|
|
||||||
type: number
|
|
||||||
required:
|
|
||||||
- tradeSymbol
|
|
||||||
- units
|
|
||||||
required:
|
|
||||||
- shipSymbol
|
|
||||||
- cooldown
|
|
||||||
- yield
|
|
||||||
required:
|
|
||||||
- data
|
|
||||||
x-examples:
|
x-examples:
|
||||||
example-1:
|
example-1:
|
||||||
data:
|
data:
|
||||||
shipSymbol: 054A8F-1
|
cooldown:
|
||||||
cooldown: 30
|
duration: 119
|
||||||
yield:
|
expiration: '2022-03-12T00:41:29.285Z'
|
||||||
tradeSymbol: SILICON
|
properties:
|
||||||
units: 10
|
data:
|
||||||
|
type: object
|
||||||
|
required:
|
||||||
|
- cooldown
|
||||||
|
properties:
|
||||||
|
cooldown:
|
||||||
|
$ref: ../models/Cooldown.yaml
|
||||||
|
required:
|
||||||
|
- data
|
||||||
examples:
|
examples:
|
||||||
Success:
|
Success:
|
||||||
value:
|
value:
|
||||||
data:
|
data:
|
||||||
shipSymbol: 054A8F-1
|
cooldown:
|
||||||
cooldown: 30
|
duration: 119
|
||||||
yield:
|
expiration: '2022-03-12T00:41:29.285Z'
|
||||||
tradeSymbol: SILICON
|
|
||||||
units: 10
|
|
||||||
description: Get the status of your last extraction.
|
description: Get the status of your last extraction.
|
||||||
security:
|
security:
|
||||||
- AgentToken: []
|
- AgentToken: []
|
||||||
|
tags:
|
||||||
|
- extract
|
||||||
|
- my
|
||||||
|
- ships
|
||||||
'/my/ships/{shipSymbol}/survey':
|
'/my/ships/{shipSymbol}/survey':
|
||||||
parameters:
|
parameters:
|
||||||
- schema:
|
- schema:
|
||||||
@ -680,7 +657,11 @@ paths:
|
|||||||
- AgentToken: []
|
- AgentToken: []
|
||||||
get:
|
get:
|
||||||
summary: Get survey cooldown
|
summary: Get survey cooldown
|
||||||
tags: []
|
tags:
|
||||||
|
- extract
|
||||||
|
- my
|
||||||
|
- survey
|
||||||
|
- ships
|
||||||
responses: {}
|
responses: {}
|
||||||
operationId: get-my-ships-shipSymbol-survey
|
operationId: get-my-ships-shipSymbol-survey
|
||||||
description: ''
|
description: ''
|
||||||
@ -1260,6 +1241,10 @@ paths:
|
|||||||
description: Get the status of your last navigation.
|
description: Get the status of your last navigation.
|
||||||
security:
|
security:
|
||||||
- AgentToken: []
|
- AgentToken: []
|
||||||
|
tags:
|
||||||
|
- my
|
||||||
|
- navigation
|
||||||
|
- ships
|
||||||
'/my/ships/{shipSymbol}':
|
'/my/ships/{shipSymbol}':
|
||||||
parameters:
|
parameters:
|
||||||
- schema:
|
- schema:
|
||||||
@ -1772,7 +1757,8 @@ paths:
|
|||||||
required: true
|
required: true
|
||||||
post:
|
post:
|
||||||
summary: Accept a contract
|
summary: Accept a contract
|
||||||
tags: []
|
tags:
|
||||||
|
- contracts
|
||||||
responses:
|
responses:
|
||||||
'201':
|
'201':
|
||||||
description: Accepted
|
description: Accepted
|
||||||
@ -1798,7 +1784,8 @@ paths:
|
|||||||
description: The system symbol
|
description: The system symbol
|
||||||
get:
|
get:
|
||||||
summary: Fetch a system
|
summary: Fetch a system
|
||||||
tags: []
|
tags:
|
||||||
|
- systems
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: OK
|
description: OK
|
||||||
|
Loading…
Reference in New Issue
Block a user