api-docs/models/Waypoint.json
2022-10-05 18:13:55 -07:00

56 lines
1.1 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": {
"type": "string",
"minLength": 1
},
"type": {
"$ref": "./WaypointType.json"
},
"systemSymbol": {
"type": "string",
"minLength": 1
},
"x": {
"type": "integer"
},
"y": {
"type": "integer"
},
"orbitals": {
"type": "array",
"items": {
"$ref": "./WaypointOrbital.json"
}
},
"factions": {
"type": "array",
"description": "The factions that are active on the waypoint.",
"items": {
"$ref": "./WaypointFaction.json"
}
},
"traits": {
"type": "array",
"description": "The traits of the waypoint.",
"items": {
"$ref": "./WaypointTrait.json"
}
},
"chart": {
"$ref": "./WaypointChart.json"
}
},
"required": [
"symbol",
"type",
"systemSymbol",
"x",
"y",
"orbitals",
"factions",
"traits"
]
}