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 scan waypoints endpoint

Browse Source
This commit is contained in:
Space Admiral 2023-02-21 08:30:25 -08:00
parent c84602e157
commit 1c25aa6e66
2 changed files with 112 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
models/ScannedWaypoint.json Normal file
View File

@ -0,0 +1,51 @@
{
"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"
}
},
"faction": {
"$ref": "./WaypointFaction.json"
},
"traits": {
"type": "array",
"description": "The traits of the waypoint.",
"items": {
"$ref": "./WaypointTrait.json"
}
},
"chart": {
"$ref": "./Chart.json"
}
},
"required": [
"symbol",
"type",
"systemSymbol",
"x",
"y",
"orbitals",
"traits"
]
}

61
reference/SpaceTraders.json
View File

@ -2105,6 +2105,67 @@
]
}
},
"/my/ships/{shipSymbol}/scan/waypoints": {
"parameters": [
{
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Activate your ship's sensor arrays to scan for waypoint information.",
"operationId": "create-ship-waypoint-scan",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"cooldown": {
"$ref": "../models/Cooldown.json"
},
"waypoints": {
"items": {
"$ref": "../models/ScannedWaypoint.json"
},
"type": "array"
}
},
"required": [
"cooldown",
"waypoints"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Created"
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Scan Waypoints",
"tags": [
"fleet"
]
}
},
"/my/ships/{shipSymbol}/scan/ships": {
"parameters": [
{