api-docs/models/Waypoint.json

54 lines
1.2 KiB
JSON
Raw Normal View History

2022-10-06 01:42:15 +02:00
{
"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",
2023-06-09 22:50:36 +02:00
"description": "Symbol fo the waypoint."
2022-10-06 01:42:15 +02:00
},
"type": {
"$ref": "./WaypointType.json"
},
"systemSymbol": {
"$ref": "./SystemSymbol.json",
2023-06-09 22:50:36 +02:00
"description": "The symbol of the system this waypoint belongs to."
2022-10-06 01:42:15 +02:00
},
"x": {
2023-06-09 22:50:36 +02:00
"type": "integer",
"description": "Position in the universe in the x axis."
2022-10-06 01:42:15 +02:00
},
"y": {
2023-06-09 22:50:36 +02:00
"type": "integer",
"description": "Position in the universe in the Y axis."
2022-10-06 01:42:15 +02:00
},
"orbitals": {
"type": "array",
2023-06-09 22:50:36 +02:00
"description": "Waypoints that orbit this waypoint.",
2022-10-06 01:42:15 +02:00
"items": {
"$ref": "./WaypointOrbital.json"
}
},
2022-10-28 06:09:27 +02:00
"faction": {
"$ref": "./WaypointFaction.json"
2022-10-06 01:42:15 +02:00
},
"traits": {
"type": "array",
"description": "The traits of the waypoint.",
"items": {
"$ref": "./WaypointTrait.json"
}
},
"chart": {
2022-10-22 18:05:01 +02:00
"$ref": "./Chart.json"
2022-10-06 01:42:15 +02:00
}
},
"required": [
"symbol",
"type",
"systemSymbol",
"x",
"y",
"orbitals",
2022-10-28 06:09:27 +02:00
"traits"
2022-10-06 01:42:15 +02:00
]
}