spacetraders/api-docs
1
0
Fork 0
mirror of https://github.com/SpaceTradersAPI/api-docs.git synced 2024-11-14 22:30:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

update: add orbits property to Waypoint and SystemWaypoint

Browse Source
This commit is contained in:
SpaceAdmiral 2023-09-15 08:57:04 -07:00
parent 6ac8e2ea8f
commit ba72f7853c
3 changed files with 25 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
models/System.json
View File

@ -16,11 +16,11 @@
}, },
"x": { "x": {
"type": "integer", "type": "integer",
"description": "Position in the universe in the x axis." "description": "Relative position of the system in the sector in the x axis."
}, },
"y": { "y": {
"type": "integer", "type": "integer",
"description": "Position in the universe in the y axis." "description": "Relative position of the system in the sector in the y axis."
}, },
"waypoints": { "waypoints": {
"type": "array", "type": "array",

19
models/SystemWaypoint.json
View File

@ -10,17 +10,30 @@
}, },
"x": { "x": {
"type": "integer", "type": "integer",
"description": "Position in the universe in the x axis." "description": "Relative position of the waypoint on the system's x axis. This is not an absolute position in the universe."
}, },
"y": { "y": {
"type": "integer", "type": "integer",
"description": "Position in the universe in the y axis." "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": [ "required": [
"symbol", "symbol",
"type", "type",
"x", "x",
"y" "y",
"orbitals"
] ]
} }

9
models/Waypoint.json
View File

@ -17,11 +17,11 @@
}, },
"x": { "x": {
"type": "integer", "type": "integer",
"description": "Position in the universe in the x axis." "description": "Relative position of the waypoint on the system's x axis. This is not an absolute position in the universe."
}, },
"y": { "y": {
"type": "integer", "type": "integer",
"description": "Position in the universe in the Y axis." "description": "Relative position of the waypoint on the system's y axis. This is not an absolute position in the universe."
}, },
"orbitals": { "orbitals": {
"type": "array", "type": "array",
@ -30,6 +30,11 @@
"$ref": "./WaypointOrbital.json" "$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": { "faction": {
"$ref": "./WaypointFaction.json" "$ref": "./WaypointFaction.json"
}, },