mirror of
https://github.com/SpaceTradersAPI/api-docs.git
synced 2024-11-14 22:30:51 +01:00
a46d675039
* update: new traits and add modifiers * breaking: jump gates and construction * update: add supply to shipyard listing * add gas siphon endpoint * add cooldown to jumps * add missing types * update supply and activity levels * update: add waypoint query filters for type and traits * add cargo modules * add shipyard activity
73 lines
1.9 KiB
JSON
73 lines
1.9 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,
|
|
"description": "Symbol fo the waypoint."
|
|
},
|
|
"type": {
|
|
"$ref": "./WaypointType.json"
|
|
},
|
|
"systemSymbol": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "The symbol of the system this waypoint belongs to."
|
|
},
|
|
"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."
|
|
},
|
|
"faction": {
|
|
"$ref": "./WaypointFaction.json"
|
|
},
|
|
"traits": {
|
|
"type": "array",
|
|
"description": "The traits of the waypoint.",
|
|
"items": {
|
|
"$ref": "./WaypointTrait.json"
|
|
}
|
|
},
|
|
"modifiers": {
|
|
"type": "array",
|
|
"description": "The modifiers of the waypoint.",
|
|
"items": {
|
|
"$ref": "./WaypointModifier.json"
|
|
}
|
|
},
|
|
"chart": {
|
|
"$ref": "./Chart.json"
|
|
},
|
|
"isUnderConstruction": {
|
|
"type": "boolean",
|
|
"description": "True if the waypoint is under construction."
|
|
}
|
|
},
|
|
"required": [
|
|
"symbol",
|
|
"type",
|
|
"systemSymbol",
|
|
"x",
|
|
"y",
|
|
"orbitals",
|
|
"traits",
|
|
"isUnderConstruction"
|
|
]
|
|
} |