mirror of
https://github.com/SpaceTradersAPI/api-docs.git
synced 2024-11-14 22:30:51 +01:00
Modified 4 files
This commit is contained in:
SpaceAdmiral
parent
8f09683e17
commit
bf05c4fb49
47
models/ScannedShip.yaml
Normal file
47
models/ScannedShip.yaml
Normal file
@ -0,0 +1,47 @@
|
||||
description: ''
|
||||
type: object
|
||||
properties:
|
||||
symbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
registration:
|
||||
type: object
|
||||
properties:
|
||||
factionSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
role:
|
||||
type: string
|
||||
minLength: 1
|
||||
required:
|
||||
- factionSymbol
|
||||
- role
|
||||
frameSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
reactorSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
engineSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
expiration:
|
||||
type: string
|
||||
minLength: 1
|
||||
required:
|
||||
- symbol
|
||||
- registration
|
||||
- frameSymbol
|
||||
- reactorSymbol
|
||||
- engineSymbol
|
||||
- expiration
|
||||
x-examples:
|
||||
example-1:
|
||||
symbol: SPACERS_GUILD-65E1BA
|
||||
registration:
|
||||
factionSymbol: SPACERS_GUILD
|
||||
role: EXCAVATOR
|
||||
frameSymbol: FRAME_LIGHT_FREIGHTER
|
||||
reactorSymbol: REACTOR_FUSION_I
|
||||
engineSymbol: ENGINE_ION_DRIVE_I
|
||||
expiration: '2022-03-12T00:44:14.222Z'
|
||||
33
models/ShipNavigation.yaml
Normal file
33
models/ShipNavigation.yaml
Normal file
@ -0,0 +1,33 @@
|
||||
description: ''
|
||||
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
|
||||
x-examples:
|
||||
example-1:
|
||||
shipSymbol: 3AE434-1
|
||||
departure: X1-OE-PM
|
||||
destination: X1-OE-A005
|
||||
durationRemaining: 2159
|
||||
arrivedAt: null
|
||||
examples:
|
||||
- shipSymbol: 3AE434-1
|
||||
departure: X1-OE-PM
|
||||
destination: X1-OE-A005
|
||||
durationRemaining: 2159
|
||||
arrivedAt: null
|
||||
29
models/Trade.yaml
Normal file
29
models/Trade.yaml
Normal file
@ -0,0 +1,29 @@
|
||||
description: ''
|
||||
type: object
|
||||
properties:
|
||||
waypointSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
tradeSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
credits:
|
||||
type: number
|
||||
units:
|
||||
type: number
|
||||
required:
|
||||
- waypointSymbol
|
||||
- tradeSymbol
|
||||
- credits
|
||||
- units
|
||||
x-examples:
|
||||
example-1:
|
||||
waypointSymbol: X1-OE-PM
|
||||
tradeSymbol: MICROPROCESSORS
|
||||
credits: -843
|
||||
units: 1
|
||||
examples:
|
||||
- waypointSymbol: X1-OE-PM
|
||||
tradeSymbol: MICROPROCESSORS
|
||||
credits: 843
|
||||
units: 1
|
||||
@ -791,27 +791,6 @@ paths:
|
||||
schema:
|
||||
description: ''
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: object
|
||||
properties:
|
||||
waypointSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
tradeSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
credits:
|
||||
type: number
|
||||
units:
|
||||
type: number
|
||||
required:
|
||||
- waypointSymbol
|
||||
- tradeSymbol
|
||||
- credits
|
||||
- units
|
||||
required:
|
||||
- data
|
||||
x-examples:
|
||||
example-1:
|
||||
data:
|
||||
@ -819,6 +798,11 @@ paths:
|
||||
tradeSymbol: MICROPROCESSORS
|
||||
credits: -843
|
||||
units: 1
|
||||
properties:
|
||||
data:
|
||||
$ref: ../models/Trade.yaml
|
||||
required:
|
||||
- data
|
||||
examples:
|
||||
Success:
|
||||
value:
|
||||
@ -899,56 +883,6 @@ paths:
|
||||
schema:
|
||||
description: ''
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: object
|
||||
properties:
|
||||
ships:
|
||||
type: array
|
||||
uniqueItems: true
|
||||
minItems: 1
|
||||
items:
|
||||
required:
|
||||
- symbol
|
||||
- frameSymbol
|
||||
- reactorSymbol
|
||||
- engineSymbol
|
||||
- expiration
|
||||
properties:
|
||||
symbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
registration:
|
||||
type: object
|
||||
properties:
|
||||
factionSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
role:
|
||||
type: string
|
||||
minLength: 1
|
||||
required:
|
||||
- factionSymbol
|
||||
- role
|
||||
frameSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
reactorSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
engineSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
expiration:
|
||||
type: string
|
||||
minLength: 1
|
||||
cooldown:
|
||||
type: number
|
||||
required:
|
||||
- ships
|
||||
- cooldown
|
||||
required:
|
||||
- data
|
||||
x-examples:
|
||||
example-1:
|
||||
data:
|
||||
@ -1034,6 +968,23 @@ paths:
|
||||
engineSymbol: ENGINE_ION_DRIVE_II
|
||||
expiration: '2022-03-08T05:19:19.726Z'
|
||||
cooldown: 60
|
||||
properties:
|
||||
data:
|
||||
type: object
|
||||
required:
|
||||
- ships
|
||||
- cooldown
|
||||
properties:
|
||||
ships:
|
||||
type: array
|
||||
uniqueItems: true
|
||||
minItems: 1
|
||||
items:
|
||||
$ref: ../models/ScannedShip.yaml
|
||||
cooldown:
|
||||
$ref: ../models/Cooldown.yaml
|
||||
required:
|
||||
- data
|
||||
examples:
|
||||
Success:
|
||||
value:
|
||||
@ -1132,6 +1083,9 @@ paths:
|
||||
properties:
|
||||
mode:
|
||||
type: string
|
||||
enum:
|
||||
- APPROACHING_SHIPS
|
||||
- DEPARTING_SHIPS
|
||||
required:
|
||||
- mode
|
||||
examples:
|
||||
@ -1165,27 +1119,6 @@ paths:
|
||||
schema:
|
||||
description: ''
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: object
|
||||
properties:
|
||||
waypointSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
tradeSymbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
credits:
|
||||
type: number
|
||||
units:
|
||||
type: number
|
||||
required:
|
||||
- waypointSymbol
|
||||
- tradeSymbol
|
||||
- credits
|
||||
- units
|
||||
required:
|
||||
- data
|
||||
x-examples:
|
||||
example-1:
|
||||
data:
|
||||
@ -1193,6 +1126,11 @@ paths:
|
||||
tradeSymbol: SILICON
|
||||
credits: 144
|
||||
units: -1
|
||||
properties:
|
||||
data:
|
||||
$ref: ../models/Trade.yaml
|
||||
required:
|
||||
- data
|
||||
examples:
|
||||
Success:
|
||||
value:
|
||||
@ -1286,8 +1224,21 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
description: ''
|
||||
type: object
|
||||
properties: {}
|
||||
x-examples:
|
||||
example-1:
|
||||
data:
|
||||
shipSymbol: 3AE434-1
|
||||
departure: X1-OE-PM
|
||||
destination: X1-OE-A005
|
||||
durationRemaining: 2159
|
||||
arrivedAt: null
|
||||
properties:
|
||||
data:
|
||||
$ref: ../models/ShipNavigation.yaml
|
||||
required:
|
||||
- data
|
||||
description: Get the status of your last navigation.
|
||||
security:
|
||||
- AgentToken: []
|
||||
@ -1844,47 +1795,6 @@ paths:
|
||||
schema:
|
||||
description: ''
|
||||
type: object
|
||||
properties:
|
||||
data:
|
||||
type: object
|
||||
properties:
|
||||
symbol:
|
||||
type: string
|
||||
minLength: 1
|
||||
sector:
|
||||
type: string
|
||||
minLength: 1
|
||||
type:
|
||||
type: string
|
||||
minLength: 1
|
||||
x:
|
||||
type: number
|
||||
'y':
|
||||
type: number
|
||||
waypoints:
|
||||
type: array
|
||||
items:
|
||||
required: []
|
||||
properties: {}
|
||||
factions:
|
||||
type: array
|
||||
items:
|
||||
required: []
|
||||
properties: {}
|
||||
charted:
|
||||
type: boolean
|
||||
chartedBy: {}
|
||||
required:
|
||||
- symbol
|
||||
- sector
|
||||
- type
|
||||
- x
|
||||
- 'y'
|
||||
- waypoints
|
||||
- factions
|
||||
- charted
|
||||
required:
|
||||
- data
|
||||
x-examples:
|
||||
example-1:
|
||||
data:
|
||||
@ -1897,6 +1807,11 @@ paths:
|
||||
factions: []
|
||||
charted: false
|
||||
chartedBy: null
|
||||
properties:
|
||||
data:
|
||||
$ref: ../models/System.yaml
|
||||
required:
|
||||
- data
|
||||
examples:
|
||||
Success:
|
||||
value:
|
||||
@ -1977,18 +1892,7 @@ paths:
|
||||
items:
|
||||
$ref: ../models/System.yaml
|
||||
meta:
|
||||
type: object
|
||||
required:
|
||||
- total
|
||||
- page
|
||||
- limit
|
||||
properties:
|
||||
total:
|
||||
type: number
|
||||
page:
|
||||
type: number
|
||||
limit:
|
||||
type: number
|
||||
$ref: ../models/Meta.yaml
|
||||
required:
|
||||
- data
|
||||
- meta
|
||||
|
||||
Loading…
Reference in New Issue
Block a user