fix: clean up docs for the api

models/Contract.json

@@ -20,7 +20,6 @@
       ]
     },
     "terms": {
-      "type": "object",
       "$ref": "./ContractTerms.json"
     },
     "accepted": {

models/ContractDeliverGood.json

@@ -1,5 +1,5 @@
 {
-  "description": "The details of a procurement contract. Includes the type of good, units needed, and the destination.",
+  "description": "The details of a delivery contract. Includes the type of good, units needed, and the destination.",
   "type": "object",
   "properties": {
     "tradeSymbol": {

models/ContractTerms.json

@@ -7,16 +7,12 @@
       "description": "The deadline for the contract."
     },
     "payment": {
-      "type": "object",
       "$ref": "./ContractPayment.json"
     },
-    "procurement": {
+    "deliver": {
       "type": "array",
-      "uniqueItems": true,
-      "minItems": 1,
       "items": {
-        "type": "object",
-        "$ref": "./ContractProcurement.json"
+        "$ref": "./ContractDeliverGood.json"
       }
     }
   },

models/Extraction.json

@@ -7,7 +7,6 @@
       "minLength": 1
     },
     "yield": {
-      "type": "object",
       "$ref": "./ExtractionYield.json"
     }
   },

models/Faction.json

@@ -21,7 +21,6 @@
     "traits": {
       "type": "array",
       "items": {
-        "type": "object",
         "$ref": "./FactionTrait.json"
       }
     }

models/ScannedShip.json

@@ -8,11 +8,9 @@
       "minLength": 8
     },
     "registration": {
-      "type": "object",
       "$ref": "./ShipRegistration.json"
     },
     "nav": {
-      "type": "object",
       "$ref": "./ShipNav.json"
     },
     "frame": {

models/ShipCargo.json

@@ -6,6 +6,11 @@
       "description": "The max number of items that can be stored in the cargo hold.",
       "minimum": 0
     },
+    "units": {
+      "type": "integer",
+      "description": "The number of items currently stored in the cargo hold.",
+      "minimum": 0
+    },
     "inventory": {
       "type": "array",
       "description": "The items currently in the cargo hold.",
@@ -16,6 +21,7 @@
   },
   "required": [
     "capacity",
+    "units",
     "inventory"
   ]
 }

models/ShipModule.json

@@ -5,13 +5,15 @@
     "symbol": {
       "type": "string",
       "enum": [
-        "MODULE_FUEL_TANK",
-        "MODULE_CARGO_HOLD",
-        "MODULE_CREW_QUARTERS",
-        "MODULE_ENVOY_QUARTERS",
         "MODULE_PASSENGER_CABIN",
+        "MODULE_ENVOY_QUARTERS",
         "MODULE_MICRO_REFINERY",
-        "MODULE_JUMP_DRIVE"
+        "MODULE_MINERAL_PROCESSOR",
+        "MODULE_CARGO_HOLD",
+        "MODULE_JUMP_DRIVE_I",
+        "MODULE_JUMP_DRIVE_II",
+        "MODULE_JUMP_DRIVE_III",
+        "MODULE_CREW_QUARTERS"
       ]
     },
     "name": {

models/ShipNavRoute.json

@@ -3,12 +3,10 @@
   "description": "The routing information for the ship's most recent transit or current location.",
   "properties": {
     "destination": {
-      "type": "object",
-      "$ref": "./Waypoint.json"
+      "$ref": "./ShipNavRouteWaypoint.json"
     },
     "departure": {
-      "type": "object",
-      "$ref": "./Waypoint.json"
+      "$ref": "./ShipNavRouteWaypoint.json"
     },
     "arrival": {
       "type": "string",

models/ShipNavRouteWaypoint.json

@@ -0,0 +1,30 @@
+{
+  "description": "The destination or departure of a ships nav route.",
+  "type": "object",
+  "properties": {
+    "symbol": {
+      "type": "string",
+      "minLength": 1
+    },
+    "type": {
+      "$ref": "./WaypointType.json"
+    },
+    "systemSymbol": {
+      "type": "string",
+      "minLength": 1
+    },
+    "x": {
+      "type": "integer"
+    },
+    "y": {
+      "type": "integer"
+    }
+  },
+  "required": [
+    "symbol",
+    "type",
+    "systemSymbol",
+    "x",
+    "y"
+  ]
+}

models/ShipRequirements.json

@@ -14,10 +14,5 @@
       "type": "integer",
       "description": "The number of module slots required for installation."
     }
-  },
-  "required": [
-    "power",
-    "crew",
-    "slots"
-  ]
+  }
 }

models/Survey.json

@@ -11,7 +11,6 @@
       "type": "array",
       "description": "A list of deposits that can be found at this location.",
       "items": {
-        "type": "object",
         "$ref": "./SurveyDeposit.json"
       }
     },

models/System.json

@@ -34,20 +34,14 @@
     "waypoints": {
       "type": "array",
       "items": {
-        "type": "object",
         "$ref": "./SystemWaypoint.json"
       }
     },
     "factions": {
       "type": "array",
       "items": {
-        "type": "object",
         "$ref": "./SystemFaction.json"
       }
-    },
-    "chart": {
-      "type": "object",
-      "$ref": "./Chart.json"
     }
   },
   "required": [
@@ -57,7 +51,6 @@
     "x",
     "y",
     "waypoints",
-    "factions",
-    "chart"
+    "factions"
   ]
 }

models/SystemWaypoint.json

@@ -2,8 +2,7 @@
   "type": "object",
   "properties": {
     "symbol": {
-      "type": "string",
-      "minLength": 1
+      "type": "string"
     }
   },
   "required": [

models/Waypoint.json

@@ -25,12 +25,8 @@
         "$ref": "./WaypointOrbital.json"
       }
     },
-    "factions": {
-      "type": "array",
-      "description": "The factions that are active on the waypoint.",
-      "items": {
-        "$ref": "./WaypointFaction.json"
-      }
+    "faction": {
+      "$ref": "./Faction.json"
     },
     "traits": {
       "type": "array",
@@ -50,8 +46,6 @@
     "x",
     "y",
     "orbitals",
-    "factions",
-    "traits",
-    "chart"
+    "traits"
   ]
 }

models/WaypointTrait.json

@@ -57,7 +57,9 @@
         "BARREN",
         "TEMPERATE",
         "JUNGLE",
-        "OCEAN"
+        "OCEAN",
+        "MARKETPLACE",
+        "SHIPYARD"
       ]
     },
     "name": {

models/WaypointType.json

@@ -9,6 +9,7 @@
     "JUMP_GATE",
     "ASTEROID_FIELD",
     "DEBRIS_FIELD",
-    "GRAVITY_WELL"
+    "GRAVITY_WELL",
+    "NEBULA"
   ]
 }