api-docs/models/ScannedSystem.json

{
  "description": "Details of a system was that scanned.",
  "type": "object",
  "properties": {
    "symbol": {
      "type": "string",
      "minLength": 1,
      "description": "Symbol of the system."
    },
    "sectorSymbol": {
      "type": "string",
      "minLength": 1,
      "description": "Symbol of the system's sector."
    },
    "type": {
      "$ref": "./SystemType.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."
    },
    "distance": {
      "type": "integer",
      "description": "The system's distance from the scanning ship."
    }
  },
  "required": [
    "symbol",
    "sectorSymbol",
    "type",
    "x",
    "y",
    "distance"
  ]
}