api-docs/models/Ship.yaml
2022-03-09 19:16:02 -08:00

122 lines
2.1 KiB
YAML

description: ''
type: object
x-examples:
example-1:
symbol: 2C52AD-1
crew: null
officers: null
frame: FRAME_FRIGATE
reactor: REACTOR_FUSION_I
engine: ENGINE_ION_DRIVE_II
modules:
- MODULE_GAS_TANK
- MODULE_CARGO_HOLD
- MODULE_CARGO_HOLD
- MODULE_CREW_QUARTERS
- MODULE_ENVOY_QUARTERS
- MODULE_JUMP_DRIVE_I
mounts:
- MOUNT_SENSOR_ARRAY_II
- MOUNT_MINING_LASER_II
- MOUNT_GAS_SIPHON_II
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: 2C52AD
fee: 0
role: COMMAND
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo:
- tradeSymbol: IRON_ORE
units: 100
properties:
symbol:
type: string
minLength: 1
frame:
type: string
minLength: 1
reactor:
type: string
minLength: 1
engine:
type: string
minLength: 1
modules:
type: array
items:
type: string
mounts:
type: array
items:
type: string
registration:
type: object
required:
- factionSymbol
- agentSymbol
- fee
- role
properties:
factionSymbol:
type: string
minLength: 1
agentSymbol:
type: string
minLength: 1
fee:
type: number
role:
type: string
minLength: 1
integrity:
type: object
required:
- frame
- reactor
- engine
properties:
frame:
type: number
reactor:
type: number
engine:
type: number
status:
type: string
minLength: 1
location:
type: string
minLength: 1
cargo:
type: array
uniqueItems: true
minItems: 1
items:
type: object
properties:
tradeSymbol:
type: string
minLength: 1
units:
type: number
required:
- tradeSymbol
- units
required:
- symbol
- frame
- reactor
- engine
- modules
- mounts
- registration
- integrity
- status
- location
- cargo