initial commit

models/Agent.yaml

@@ -0,0 +1,30 @@
+description: ''
+type: object
+x-examples:
+  example-1:
+    accountId: cl0hok34m0003ks0jjql5q8f2
+    symbol: 2C52AD
+    headquarters: X1-OE-PM
+    credits: 0
+properties:
+  accountId:
+    type: string
+    minLength: 1
+  symbol:
+    type: string
+    minLength: 1
+  headquarters:
+    type: string
+    minLength: 1
+  credits:
+    type: number
+required:
+  - accountId
+  - symbol
+  - headquarters
+  - credits
+examples:
+  - accountId: cl0hok34m0003ks0jjql5q8f2
+    symbol: EMBER
+    headquarters: X1-OE-PM
+    credits: 0

models/Contract.yaml

@@ -0,0 +1,103 @@
+description: ''
+type: object
+properties:
+  id:
+    type: string
+    minLength: 1
+  faction:
+    type: string
+    minLength: 1
+  type:
+    type: string
+    minLength: 1
+  terms:
+    type: object
+    properties:
+      deadline:
+        type: string
+        minLength: 1
+      payment:
+        type: object
+        properties:
+          onAccepted:
+            type: number
+          onFulfilled:
+            type: number
+        required:
+          - onAccepted
+          - onFulfilled
+      deliver:
+        type: array
+        uniqueItems: true
+        minItems: 1
+        items:
+          required:
+            - tradeSymbol
+            - destination
+            - units
+            - fulfilled
+          properties:
+            tradeSymbol:
+              type: string
+              minLength: 1
+            destination:
+              type: string
+              minLength: 1
+            units:
+              type: number
+            fulfilled:
+              type: number
+    required:
+      - deadline
+      - payment
+      - deliver
+  accepted:
+    type: boolean
+  fulfilled:
+    type: boolean
+  expiresAt:
+    type: string
+    minLength: 1
+required:
+  - id
+  - faction
+  - type
+  - terms
+  - accepted
+  - fulfilled
+  - expiresAt
+x-examples:
+  example-1:
+    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'
+examples:
+  - 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'

models/ContractDelivery.yaml

@@ -0,0 +1,36 @@
+description: ''
+type: object
+properties:
+  data:
+    type: object
+    properties:
+      tradeSymbol:
+        type: string
+        minLength: 1
+      destination:
+        type: string
+        minLength: 1
+      units:
+        type: number
+      fulfilled:
+        type: number
+    required:
+      - tradeSymbol
+      - destination
+      - units
+      - fulfilled
+required:
+  - data
+x-examples:
+  example-1:
+    data:
+      tradeSymbol: IRON_ORE
+      destination: X1-OE-PM
+      units: 10000
+      fulfilled: 500
+examples:
+  - data:
+      tradeSymbol: IRON_ORE
+      destination: X1-OE-PM
+      units: 10000
+      fulfilled: 500

models/Faction.yaml

@@ -0,0 +1,46 @@
+description: ''
+type: object
+x-examples:
+  example-1:
+    symbol: COMMERCE_REPUBLIC
+    name: Commerce Repubic
+    description: The Commerce Republic takes capital from top tier worlds and invests it into new systems with high potential for growth.
+    headquarters: X1-OE-PM
+    traits:
+      - BUREAUCRATIC
+      - CAPITALISTIC
+      - GUILD
+      - ESTABLISHED
+examples:
+  - symbol: COMMERCE_REPUBLIC
+    name: Commerce Repubic
+    description: The Commerce Republic takes capital from top tier worlds and invests it into new systems with high potential for growth.
+    headquarters: X1-OE-PM
+    traits:
+      - BUREAUCRATIC
+      - CAPITALISTIC
+      - GUILD
+      - ESTABLISHED
+properties:
+  symbol:
+    type: string
+    minLength: 1
+  name:
+    type: string
+    minLength: 1
+  description:
+    type: string
+    minLength: 1
+  headquarters:
+    type: string
+    minLength: 1
+  traits:
+    type: array
+    items:
+      type: string
+required:
+  - symbol
+  - name
+  - description
+  - headquarters
+  - traits

models/Meta.yaml

@@ -0,0 +1,22 @@
+description: ''
+type: object
+properties:
+  total:
+    type: number
+  page:
+    type: number
+  limit:
+    type: number
+required:
+  - total
+  - page
+  - limit
+x-examples:
+  example-1:
+    total: 6
+    page: 1
+    limit: 20
+examples:
+  - total: 10
+    page: 1
+    limit: 10

models/Ship.yaml

@@ -0,0 +1,121 @@
+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

models/Survey.yaml

@@ -0,0 +1,28 @@
+description: ''
+type: object
+x-examples:
+  example-1:
+    signature: X1-OE-D2DD38
+    deposits:
+      - COPPER_ORE
+    expiration: '2022-03-08T05:41:55.514Z'
+properties:
+  signature:
+    type: string
+    minLength: 1
+  deposits:
+    type: array
+    items:
+      type: string
+  expiration:
+    type: string
+    minLength: 1
+required:
+  - signature
+  - deposits
+  - expiration
+examples:
+  - signature: X1-OE-D2DD38
+    deposits:
+      - COPPER_ORE
+    expiration: '2022-03-08T05:41:55.514Z'