api-docs/models/SystemWaypoint.json

39 lines
1017 B
JSON

{
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The symbol of the waypoint."
},
"type": {
"$ref": "./WaypointType.json"
},
"x": {
"type": "integer",
"description": "Relative position of the waypoint on the system's x axis. This is not an absolute position in the universe."
},
"y": {
"type": "integer",
"description": "Relative position of the waypoint on the system's y axis. This is not an absolute position in the universe."
},
"orbitals": {
"type": "array",
"description": "Waypoints that orbit this waypoint.",
"items": {
"$ref": "./WaypointOrbital.json"
}
},
"orbits": {
"type": "string",
"minLength": 1,
"description": "The symbol of the parent waypoint, if this waypoint is in orbit around another waypoint. Otherwise this value is undefined."
}
},
"required": [
"symbol",
"type",
"x",
"y",
"orbitals"
]
}