spacetraders/api-docs
1
0
Fork 0
mirror of https://github.com/SpaceTradersAPI/api-docs.git synced 2024-12-25 22:28:06 +01:00
Code Issues Packages Projects Releases Wiki Activity

Modified reference/SpaceTraders.yaml

Browse Source
This commit is contained in:
SpaceAdmiral 2022-03-10 20:37:39 -08:00
parent 6e198f34a4
commit 4303299987
1 changed files with 108 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
reference/SpaceTraders.yaml
View File

@ -252,6 +252,21 @@ paths:
operationId: post-my-ships-shipSymbol-deliver
security:
- AgentToken: []
requestBody:
content:
application/json:
schema:
type: object
properties:
contractId:
type: string
tradeSymbol:
type: string
units:
type: number
required:
- contractId
- tradeSymbol
'/my/ships/{shipSymbol}/dock':
parameters:
- schema:
@ -1608,6 +1623,99 @@ paths:
description: Retrieve all of your ships.
security:
- AgentToken: []
/my/contracts:
get:
summary: List all of your contracts
tags:
- my
- contracts
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
- id: cl0hok38t0014ks0jnoy8o5vh
faction: COMMERCE_REPUBLIC
type: PROCUREMENT
terms:
deadline: '2022-03-11T05:16:59.113Z'
payment:
onAccepted: 20000
onFulfilled: 100000
deliver:
- tradeSymbol: IRON_ORE
destination: X1-OE-PM
units: 10000
fulfilled: 0
accepted: false
fulfilled: false
expiresAt: '2022-03-09T05:16:59.112Z'
- id: cl0hok3920023kv0jflbjpltg
faction: COMMERCE_REPUBLIC
type: PROCUREMENT
terms:
deadline: '2022-03-11T05:16:59.123Z'
payment:
onAccepted: 20000
onFulfilled: 100000
deliver:
- tradeSymbol: IRON_ORE
destination: X1-OE-PM
units: 10000
fulfilled: 0
accepted: false
fulfilled: false
expiresAt: '2022-03-09T05:16:59.122Z'
meta:
total: 2
page: 1
limit: 20
properties:
data:
type: array
uniqueItems: true
minItems: 1
items:
$ref: ../models/Contract.yaml
meta:
$ref: ../models/Meta.yaml
required:
- data
- meta
examples:
Success:
value:
data:
- id: cl0hok38t0014ks0jnoy8o5vh
faction: COMMERCE_REPUBLIC
type: PROCUREMENT
terms:
deadline: '2022-03-11T05:16:59.113Z'
payment:
onAccepted: 20000
onFulfilled: 100000
deliver:
- tradeSymbol: IRON_ORE
destination: X1-OE-PM
units: 10000
fulfilled: 0
accepted: false
fulfilled: false
expiresAt: '2022-03-09T05:16:59.112Z'
meta:
total: 10
page: 1
limit: 10
operationId: get-my-contracts
security:
- AgentToken: []
description: List all of your contracts.
'/systems/{systemSymbol}':
parameters:
- schema: