api-docs/models/ScannedShip.json

78 lines
1.7 KiB
JSON
Raw Normal View History

2022-10-22 18:05:01 +02:00
{
"description": "The ship that was scanned. Details include information about the ship that could be detected by the scanner.",
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The globally unique identifier of the ship."
2022-10-22 18:05:01 +02:00
},
"registration": {
"$ref": "./ShipRegistration.json"
},
"nav": {
"$ref": "./ShipNav.json"
},
"frame": {
"type": "object",
"description": "The frame of the ship.",
"properties": {
"symbol": {
2023-06-09 22:50:36 +02:00
"type": "string",
"description": "The symbol of the frame."
}
},
"required": [
"symbol"
]
2022-10-22 18:05:01 +02:00
},
"reactor": {
"type": "object",
"description": "The reactor of the ship.",
"properties": {
"symbol": {
2023-06-09 22:50:36 +02:00
"type": "string",
"description": "The symbol of the reactor."
}
},
"required": [
"symbol"
]
2022-10-22 18:05:01 +02:00
},
"engine": {
"type": "object",
"description": "The engine of the ship.",
2023-06-09 22:50:36 +02:00
"required": [
"symbol"
],
"properties": {
"symbol": {
2023-06-09 22:50:36 +02:00
"type": "string",
"description": "The symbol of the engine."
}
2023-06-09 22:50:36 +02:00
}
2022-10-22 18:05:01 +02:00
},
"mounts": {
"type": "array",
2023-06-09 22:50:36 +02:00
"description": "List of mounts installed in the ship.",
2022-10-22 18:05:01 +02:00
"items": {
"type": "object",
"description": "A mount on the ship.",
"properties": {
"symbol": {
2023-06-09 22:50:36 +02:00
"type": "string",
"description": "The symbol of the mount."
}
},
"required": [
"symbol"
]
2022-10-22 18:05:01 +02:00
}
}
},
"required": [
"symbol",
"registration",
"nav",
"engine"
2022-10-22 18:05:01 +02:00
]
}