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

update numbers to integers where appropriate

Browse Source
This commit is contained in:
Space Admiral 2022-03-23 08:37:54 -07:00
parent 4fbd83c2e4
commit 078ca60601
13 changed files with 53 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
models/Agent.yaml
View File

@ -1,4 +1,4 @@
description: '' description: ""
type: object type: object
x-examples: x-examples:
example-1: example-1:
@ -17,7 +17,7 @@ properties:
type: string type: string
minLength: 1 minLength: 1
credits: credits:
type: number type: integer
required: required:
- accountId - accountId
- symbol - symbol

18
models/Contract.yaml
View File

@ -1,4 +1,4 @@
description: '' description: ""
type: object type: object
properties: properties:
id: id:
@ -20,9 +20,9 @@ properties:
type: object type: object
properties: properties:
onAccepted: onAccepted:
type: number type: integer
onFulfilled: onFulfilled:
type: number type: integer
required: required:
- onAccepted - onAccepted
- onFulfilled - onFulfilled
@ -44,9 +44,9 @@ properties:
type: string type: string
minLength: 1 minLength: 1
units: units:
type: number type: integer
fulfilled: fulfilled:
type: number type: integer
required: required:
- deadline - deadline
- payment - payment
@ -72,7 +72,7 @@ x-examples:
faction: COMMERCE_REPUBLIC faction: COMMERCE_REPUBLIC
type: PROCUREMENT type: PROCUREMENT
terms: terms:
deadline: '2022-03-11T05:16:59.113Z' deadline: "2022-03-11T05:16:59.113Z"
payment: payment:
onAccepted: 20000 onAccepted: 20000
onFulfilled: 100000 onFulfilled: 100000
@ -83,13 +83,13 @@ x-examples:
fulfilled: 0 fulfilled: 0
accepted: false accepted: false
fulfilled: false fulfilled: false
expiresAt: '2022-03-09T05:16:59.112Z' expiresAt: "2022-03-09T05:16:59.112Z"
examples: examples:
- id: cl0hok38t0014ks0jnoy8o5vh - id: cl0hok38t0014ks0jnoy8o5vh
faction: COMMERCE_REPUBLIC faction: COMMERCE_REPUBLIC
type: PROCUREMENT type: PROCUREMENT
terms: terms:
deadline: '2022-03-11T05:16:59.113Z' deadline: "2022-03-11T05:16:59.113Z"
payment: payment:
onAccepted: 20000 onAccepted: 20000
onFulfilled: 100000 onFulfilled: 100000
@ -100,4 +100,4 @@ examples:
fulfilled: 0 fulfilled: 0
accepted: false accepted: false
fulfilled: false fulfilled: false
expiresAt: '2022-03-09T05:16:59.112Z' expiresAt: "2022-03-09T05:16:59.112Z"

6
models/ContractDelivery.yaml
View File

@ -1,4 +1,4 @@
description: '' description: ""
type: object type: object
properties: properties:
data: data:
@ -11,9 +11,9 @@ properties:
type: string type: string
minLength: 1 minLength: 1
units: units:
type: number type: integer
fulfilled: fulfilled:
type: number type: integer
required: required:
- tradeSymbol - tradeSymbol
- destination - destination

8
models/Cooldown.yaml
View File

@ -1,8 +1,8 @@
description: '' description: ""
type: object type: object
properties: properties:
duration: duration:
type: number type: integer
expiration: expiration:
type: string type: string
minLength: 1 minLength: 1
@ -12,7 +12,7 @@ required:
x-examples: x-examples:
example-1: example-1:
duration: 119 duration: 119
expiration: '2022-03-12T00:41:29.285Z' expiration: "2022-03-12T00:41:29.285Z"
examples: examples:
- duration: 119 - duration: 119
expiration: '2022-03-12T00:41:29.285Z' expiration: "2022-03-12T00:41:29.285Z"

4
models/Extraction.yaml
View File

@ -1,4 +1,4 @@
description: '' description: ""
type: object type: object
properties: properties:
shipSymbol: shipSymbol:
@ -11,7 +11,7 @@ properties:
type: string type: string
minLength: 1 minLength: 1
units: units:
type: number type: integer
required: required:
- tradeSymbol - tradeSymbol
- units - units

4
models/MarketTrade.yaml
View File

@ -8,9 +8,9 @@ properties:
type: string type: string
minLength: 1 minLength: 1
price: price:
type: number type: integer
tariff: tariff:
type: number type: integer
required: required:
- waypointSymbol - waypointSymbol
- tradeSymbol - tradeSymbol

8
models/Meta.yaml
View File

@ -1,12 +1,12 @@
description: '' description: ""
type: object type: object
properties: properties:
total: total:
type: number type: integer
page: page:
type: number type: integer
limit: limit:
type: number type: integer
required: required:
- total - total
- page - page

8
models/Ship.yaml
View File

@ -1,4 +1,4 @@
description: '' description: ""
type: object type: object
x-examples: x-examples:
example-1: example-1:
@ -93,7 +93,7 @@ properties:
type: string type: string
minLength: 1 minLength: 1
fee: fee:
type: number type: integer
role: role:
type: string type: string
minLength: 1 minLength: 1
@ -127,12 +127,12 @@ properties:
type: string type: string
minLength: 1 minLength: 1
units: units:
type: number type: integer
required: required:
- tradeSymbol - tradeSymbol
- units - units
fuel: fuel:
type: number type: integer
required: required:
- symbol - symbol
- frame - frame

4
models/ShipNavigation.yaml
View File

@ -1,4 +1,4 @@
description: '' description: ""
type: object type: object
properties: properties:
shipSymbol: shipSymbol:
@ -11,7 +11,7 @@ properties:
type: string type: string
minLength: 1 minLength: 1
durationRemaining: durationRemaining:
type: number type: integer
arrivedAt: {} arrivedAt: {}
required: required:
- shipSymbol - shipSymbol

4
models/ShipyardListing.yaml
View File

@ -1,4 +1,4 @@
description: '' description: ""
type: object type: object
x-examples: x-examples:
example-1: example-1:
@ -33,7 +33,7 @@ properties:
type: string type: string
minLength: 1 minLength: 1
price: price:
type: number type: integer
role: role:
type: string type: string
minLength: 1 minLength: 1

16
models/System.yaml
View File

@ -1,4 +1,4 @@
description: '' description: ""
type: object type: object
x-examples: x-examples:
example-1: example-1:
@ -6,7 +6,7 @@ x-examples:
sector: X1 sector: X1
type: RED_STAR type: RED_STAR
x: 0 x: 0
'y': 0 "y": 0
waypoints: waypoints:
- X1-OE-PM - X1-OE-PM
- X1-OE-PM01 - X1-OE-PM01
@ -23,7 +23,7 @@ examples:
sector: X1 sector: X1
type: RED_STAR type: RED_STAR
x: 0 x: 0
'y': 0 "y": 0
waypoints: waypoints:
- X1-OE-PM - X1-OE-PM
- X1-OE-PM01 - X1-OE-PM01
@ -46,9 +46,9 @@ properties:
type: string type: string
minLength: 1 minLength: 1
x: x:
type: number type: integer
'y': "y":
type: number type: integer
waypoints: waypoints:
type: array type: array
items: items:
@ -62,13 +62,13 @@ properties:
chartedBy: chartedBy:
type: type:
- string - string
- 'null' - "null"
required: required:
- symbol - symbol
- sector - sector
- type - type
- x - x
- 'y' - "y"
- waypoints - waypoints
- factions - factions
- charted - charted

6
models/Trade.yaml
View File

@ -1,4 +1,4 @@
description: '' description: ""
type: object type: object
properties: properties:
waypointSymbol: waypointSymbol:
@ -8,9 +8,9 @@ properties:
type: string type: string
minLength: 1 minLength: 1
credits: credits:
type: number type: integer
units: units:
type: number type: integer
required: required:
- waypointSymbol - waypointSymbol
- tradeSymbol - tradeSymbol

16
models/Waypoint.yaml
View File

@ -1,4 +1,4 @@
description: '' description: ""
type: object type: object
x-examples: x-examples:
example-1: example-1:
@ -6,7 +6,7 @@ x-examples:
symbol: X1-OE-PM symbol: X1-OE-PM
type: PLANET type: PLANET
x: 10 x: 10
'y': 5 "y": 5
orbitals: orbitals:
- X1-OE-PM01 - X1-OE-PM01
faction: COMMERCE_REPUBLIC faction: COMMERCE_REPUBLIC
@ -26,7 +26,7 @@ examples:
symbol: X1-OE-PM symbol: X1-OE-PM
type: PLANET type: PLANET
x: 10 x: 10
'y': 5 "y": 5
orbitals: orbitals:
- X1-OE-PM01 - X1-OE-PM01
faction: COMMERCE_REPUBLIC faction: COMMERCE_REPUBLIC
@ -52,9 +52,9 @@ properties:
type: string type: string
minLength: 1 minLength: 1
x: x:
type: number type: integer
'y': "y":
type: number type: integer
orbitals: orbitals:
type: array type: array
items: items:
@ -75,13 +75,13 @@ properties:
chartedBy: chartedBy:
type: type:
- string - string
- 'null' - "null"
required: required:
- system - system
- symbol - symbol
- type - type
- x - x
- 'y' - "y"
- orbitals - orbitals
- faction - faction
- features - features