api-docs/models/Waypoint.json

54 lines
1.2 KiB
JSON

{
"description": "A waypoint is a location that ships can travel to such as a Planet, Moon or Space Station.",
"type": "object",
"properties": {
"symbol": {
"$ref": "./WaypointSymbol.json",
"description": "Symbol fo the waypoint."
},
"type": {
"$ref": "./WaypointType.json"
},
"systemSymbol": {
"$ref": "./SystemSymbol.json",
"description": "The symbol of the system this waypoint belongs to."
},
"x": {
"type": "integer",
"description": "Position in the universe in the x axis."
},
"y": {
"type": "integer",
"description": "Position in the universe in the Y axis."
},
"orbitals": {
"type": "array",
"description": "Waypoints that orbit this waypoint.",
"items": {
"$ref": "./WaypointOrbital.json"
}
},
"faction": {
"$ref": "./WaypointFaction.json"
},
"traits": {
"type": "array",
"description": "The traits of the waypoint.",
"items": {
"$ref": "./WaypointTrait.json"
}
},
"chart": {
"$ref": "./Chart.json"
}
},
"required": [
"symbol",
"type",
"systemSymbol",
"x",
"y",
"orbitals",
"traits"
]
}