api-docs/models/ConnectedSystem.json

42 lines
935 B
JSON
Raw Normal View History

2022-12-23 17:57:37 +01:00
{
"type": "object",
"properties": {
"symbol": {
"type": "string",
2023-06-09 22:50:36 +02:00
"minLength": 1,
"description": "The symbol of the system."
2022-12-23 17:57:37 +01:00
},
"sectorSymbol": {
"type": "string",
2023-06-09 22:50:36 +02:00
"minLength": 1,
"description": "The sector of this system."
2022-12-23 17:57:37 +01:00
},
"type": {
"$ref": "./SystemType.json"
},
"factionSymbol": {
"type": "string",
"description": "The symbol of the faction that owns the connected jump gate in the system."
},
"x": {
2023-06-09 22:50:36 +02:00
"type": "integer",
"description": "Position in the universe in the x axis."
2022-12-23 17:57:37 +01:00
},
"y": {
2023-06-09 22:50:36 +02:00
"type": "integer",
"description": "Position in the universe in the y axis."
2022-12-23 17:57:37 +01:00
},
"distance": {
2023-06-09 22:50:36 +02:00
"type": "integer",
"description": "The distance of this system to the connected Jump Gate."
2022-12-23 17:57:37 +01:00
}
},
"required": [
"symbol",
"sectorSymbol",
"type",
"x",
"y",
"distance"
]
}