Remove $ref siblings, Agent.shipCount NOT optional, typos (#82)

* Typo and descriptions

* Remove $ref suiblings.

* missed one when refactoring ShipNavRouteWaypointDeprecated to keep deprecated flag.

* Agent.shipCount always seems to be returned. Why would this be optional?

models/Agent.json

@@ -37,6 +37,7 @@
     "symbol",
     "headquarters",
     "credits",
-    "startingFaction"
+    "startingFaction",
+    "shipCount"
   ]
 }

models/Chart.json

@@ -3,8 +3,7 @@
   "description": "The chart of a system or waypoint, which makes the location visible to other agents.",
   "properties": {
     "waypointSymbol": {
-      "$ref": "./WaypointSymbol.json",
+      "$ref": "./WaypointSymbol.json"
-      "description": "The symbol of the waypoint."
     },
     "submittedBy": {
       "type": "string",

models/Contract.json

@@ -22,8 +22,7 @@
       "description": "Type of contract."
     },
     "terms": {
-      "$ref": "./ContractTerms.json",
+      "$ref": "./ContractTerms.json"
-      "description": "The terms to fulfill the contract."
     },
     "accepted": {
       "type": "boolean",

models/ContractPayment.json

@@ -1,5 +1,6 @@
 {
   "type": "object",
+  "description": "Payments for the contract.",
   "properties": {
     "onAccepted": {
       "type": "integer",

models/ContractTerms.json

@@ -1,6 +1,6 @@
 {
   "type": "object",
-  "description": "Terms of the contract needed to fulfill it.",
+  "description": "The terms to fulfill the contract.",
   "properties": {
     "deadline": {
       "type": "string",
@@ -8,8 +8,7 @@
       "description": "The deadline for the contract."
     },
     "payment": {
-      "$ref": "./ContractPayment.json",
+      "$ref": "./ContractPayment.json"
-      "description": "Payments for the contract."
     },
     "deliver": {
       "type": "array",

models/Extraction.json

@@ -8,8 +8,7 @@
       "description": "Symbol of the ship that executed the extraction."
     },
     "yield": {
-      "$ref": "./ExtractionYield.json",
+      "$ref": "./ExtractionYield.json"
-      "description": "Yields from the extract operation."
     }
   },
   "required": [

models/ExtractionYield.json

@@ -3,8 +3,7 @@
   "description": "A yield from the extraction operation.",
   "properties": {
     "symbol": {
-      "$ref": "./TradeSymbol.json",
+      "$ref": "./TradeSymbol.json"
-      "description": "Symbol of the good that was extracted."
     },
     "units": {
       "type": "integer",

models/Faction.json

@@ -3,8 +3,7 @@
   "type": "object",
   "properties": {
     "symbol": {
-      "$ref": "./FactionSymbol.json",
+      "$ref": "./FactionSymbol.json"
-      "description": "Faction symbol."
     },
     "name": {
       "type": "string",

models/MarketTransaction.json

@@ -2,8 +2,7 @@
   "type": "object",
   "properties": {
     "waypointSymbol": {
-      "$ref": "./WaypointSymbol.json",
+      "$ref": "./WaypointSymbol.json"
-      "description": "The symbol of the waypoint where the transaction took place."
     },
     "shipSymbol": {
       "type": "string",

models/ScannedWaypoint.json

@@ -3,15 +3,13 @@
   "type": "object",
   "properties": {
     "symbol": {
-      "$ref": "./WaypointSymbol.json",
+      "$ref": "./WaypointSymbol.json"
-      "description": "Symbol of the waypoint."
     },
     "type": {
       "$ref": "./WaypointType.json"
     },
     "systemSymbol": {
-      "$ref": "./SystemSymbol.json",
+      "$ref": "./SystemSymbol.json"
-      "description": "Symbol of the system."
     },
     "x": {
       "type": "integer",

models/ShipNav.json

@@ -3,12 +3,10 @@
   "description": "The navigation information of the ship.",
   "properties": {
     "systemSymbol": {
-      "$ref": "./SystemSymbol.json",
+      "$ref": "./SystemSymbol.json"
-      "description": "The system symbol of the ship's current location."
     },
     "waypointSymbol": {
-      "$ref": "./WaypointSymbol.json",
+      "$ref": "./WaypointSymbol.json"
-      "description": "The waypoint symbol of the ship's current location, or if the ship is in-transit, the waypoint symbol of the ship's destination."
     },
     "route": {
       "$ref": "./ShipNavRoute.json"

models/ShipNavRoute.json

@@ -6,9 +6,7 @@
       "$ref": "./ShipNavRouteWaypoint.json"
     },
     "departure": {
-      "deprecated": true,
+      "$ref": "./ShipNavRouteWaypointDeprecated.json"
-      "description": "Deprecated. Use origin instead.",
-      "$ref": "./ShipNavRouteWaypoint.json"
     },
     "origin": {
       "$ref": "./ShipNavRouteWaypoint.json"

models/ShipNavRouteWaypoint.json

@@ -11,8 +11,7 @@
       "$ref": "./WaypointType.json"
     },
     "systemSymbol": {
-      "$ref": "./SystemSymbol.json",
+      "$ref": "./SystemSymbol.json"
-      "description": "The symbol of the system the waypoint is in."
     },
     "x": {
       "type": "integer",

models/ShipNavRouteWaypointDeprecated.json

@@ -0,0 +1,33 @@
+{
+  "type": "object",
+  "deprecated": true,
+  "description": "Deprecated. Use origin instead.",
+  "properties": {
+    "symbol": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The symbol of the waypoint."
+    },
+    "type": {
+      "$ref": "./WaypointType.json"
+    },
+    "systemSymbol": {
+      "$ref": "./SystemSymbol.json"
+    },
+    "x": {
+      "type": "integer",
+      "description": "Position in the universe in the x axis."
+    },
+    "y": {
+      "type": "integer",
+      "description": "Position in the universe in the y axis."
+    }
+  },
+  "required": [
+    "symbol",
+    "type",
+    "systemSymbol",
+    "x",
+    "y"
+  ]
+}

models/ShipyardTransaction.json

@@ -3,8 +3,7 @@
   "description": "Results of a transaction with a shipyard.",
   "properties": {
     "waypointSymbol": {
-      "$ref": "./WaypointSymbol.json",
+      "$ref": "./WaypointSymbol.json"
-      "description": "The symbol of the waypoint where the transaction took place."
     },
     "shipSymbol": {
       "type": "string",

models/Siphon.json

@@ -8,8 +8,7 @@
       "description": "Symbol of the ship that executed the siphon."
     },
     "yield": {
-      "$ref": "./SiphonYield.json",
+      "$ref": "./SiphonYield.json"
-      "description": "Yields from the siphon operation."
     }
   },
   "required": [

models/SiphonYield.json

@@ -3,8 +3,7 @@
   "description": "A yield from the siphon operation.",
   "properties": {
     "symbol": {
-      "$ref": "./TradeSymbol.json",
+      "$ref": "./TradeSymbol.json"
-      "description": "Symbol of the good that was siphoned."
     },
     "units": {
       "type": "integer",

models/SystemSymbol.json

@@ -1,5 +1,6 @@
 {
   "type": "string",
+  "description": "The symbol of the system.",
   "minLength": 1,
   "x-faker": {
     "fake": ["X1-{{random.alphaNumeric(5)}}"]

models/SystemWaypoint.json

@@ -2,8 +2,7 @@
   "type": "object",
   "properties": {
     "symbol": {
-      "$ref": "./WaypointSymbol.json",
+      "$ref": "./WaypointSymbol.json"
-      "description": "The symbol of the waypoint."
     },
     "type": {
       "$ref": "./WaypointType.json"

models/Waypoint.json

@@ -3,15 +3,13 @@
   "type": "object",
   "properties": {
     "symbol": {
-      "$ref": "./WaypointSymbol.json",
+      "$ref": "./WaypointSymbol.json"
-      "description": "Symbol fo the waypoint."
     },
     "type": {
       "$ref": "./WaypointType.json"
     },
     "systemSymbol": {
-      "$ref": "./SystemSymbol.json",
+      "$ref": "./SystemSymbol.json"
-      "description": "The symbol of the system this waypoint belongs to."
     },
     "x": {
       "type": "integer",

models/WaypointSymbol.json

@@ -1,5 +1,6 @@
 {
   "type": "string",
+  "description": "The symbol of the waypoint.",
   "minLength": 1,
   "x-faker": {
     "fake": ["X1-{{random.alphaNumeric(5)}}-{{random.alphaNumeric(5)}}"]

reference/SpaceTraders.json

@@ -254,8 +254,7 @@
               "schema": {
                 "properties": {
                   "faction": {
-                    "$ref": "../models/FactionSymbol.json",
+                    "$ref": "../models/FactionSymbol.json"
-                    "example": "COSMIC"
                   },
                   "symbol": {
                     "description": "Your desired agent symbol. This will be a unique name used to represent your agent, and will be the prefix for your ships.",