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

Added WaypointSymbol.json and SystemSymbol.json and symbol mocks for both

Browse Source
This commit is contained in:
Ashwin Naren 2023-06-10 18:02:06 -07:00
parent a121b573e7
commit 8400730f63
10 changed files with 25 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
models/Chart.json
View File

@ -3,7 +3,7 @@
"description": "The chart of a system or waypoint, which makes the location visible to other agents.", "description": "The chart of a system or waypoint, which makes the location visible to other agents.",
"properties": { "properties": {
"waypointSymbol": { "waypointSymbol": {
"type": "string", "$ref": "./WaypointSymbol.json",
"description": "The symbol of the waypoint." "description": "The symbol of the waypoint."
}, },
"submittedBy": { "submittedBy": {

2
models/MarketTransaction.json
View File

@ -2,7 +2,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"waypointSymbol": { "waypointSymbol": {
"type": "string", "$ref": "./WaypointSymbol.json",
"description": "The symbol of the waypoint where the transaction took place." "description": "The symbol of the waypoint where the transaction took place."
}, },
"shipSymbol": { "shipSymbol": {

6
models/ScannedWaypoint.json
View File

@ -3,16 +3,14 @@
"type": "object", "type": "object",
"properties": { "properties": {
"symbol": { "symbol": {
"type": "string", "$ref": "./WaypointSymbol.json",
"minLength": 1,
"description": "Symbol of the waypoint." "description": "Symbol of the waypoint."
}, },
"type": { "type": {
"$ref": "./WaypointType.json" "$ref": "./WaypointType.json"
}, },
"systemSymbol": { "systemSymbol": {
"type": "string", "$ref": "./SystemSymbol.json",
"minLength": 1,
"description": "Symbol of the system." "description": "Symbol of the system."
}, },
"x": { "x": {

4
models/ShipNav.json
View File

@ -3,11 +3,11 @@
"description": "The navigation information of the ship.", "description": "The navigation information of the ship.",
"properties": { "properties": {
"systemSymbol": { "systemSymbol": {
"type": "string", "$ref": "./SystemSymbol.json",
"description": "The system symbol of the ship's current location." "description": "The system symbol of the ship's current location."
}, },
"waypointSymbol": { "waypointSymbol": {
"type": "string", "$ref": "./WaypointSymbol.json",
"description": "The waypoint symbol of the ship's current location, or if the ship is in-transit, the waypoint symbol of the ship's destination." "description": "The waypoint symbol of the ship's current location, or if the ship is in-transit, the waypoint symbol of the ship's destination."
}, },
"route": { "route": {

3
models/ShipNavRouteWaypoint.json
View File

@ -11,8 +11,7 @@
"$ref": "./WaypointType.json" "$ref": "./WaypointType.json"
}, },
"systemSymbol": { "systemSymbol": {
"type": "string", "$ref": "./SystemSymbol.json",
"minLength": 1,
"description": "The symbol of the system the waypoint is in." "description": "The symbol of the system the waypoint is in."
}, },
"x": { "x": {

2
models/ShipyardTransaction.json
View File

@ -3,7 +3,7 @@
"description": "Results of a transaction with a shipyard.", "description": "Results of a transaction with a shipyard.",
"properties": { "properties": {
"waypointSymbol": { "waypointSymbol": {
"type": "string", "$ref": "./WaypointSymbol.json",
"description": "The symbol of the waypoint where the transaction took place." "description": "The symbol of the waypoint where the transaction took place."
}, },
"shipSymbol": { "shipSymbol": {

7
models/SystemSymbol.json Normal file
View File

@ -0,0 +1,7 @@
{
"type": "string",
"minLength": 1,
"x-faker": {
"fake": ["X1-{{random.alphaNumeric(5)}}"]
}
}

2
models/SystemWaypoint.json
View File

@ -2,7 +2,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"symbol": { "symbol": {
"type": "string", "$ref": "./WaypointSymbol.json",
"description": "The symbol of the waypoint." "description": "The symbol of the waypoint."
}, },
"type": { "type": {

6
models/Waypoint.json
View File

@ -3,16 +3,14 @@
"type": "object", "type": "object",
"properties": { "properties": {
"symbol": { "symbol": {
"type": "string", "$ref": "./WaypointSymbol.json",
"minLength": 1,
"description": "Symbol fo the waypoint." "description": "Symbol fo the waypoint."
}, },
"type": { "type": {
"$ref": "./WaypointType.json" "$ref": "./WaypointType.json"
}, },
"systemSymbol": { "systemSymbol": {
"type": "string", "$ref": "./SystemSymbol.json",
"minLength": 1,
"description": "The symbol of the system this waypoint belongs to." "description": "The symbol of the system this waypoint belongs to."
}, },
"x": { "x": {

7
models/WaypointSymbol.json Normal file
View File

@ -0,0 +1,7 @@
{
"type": "string",
"minLength": 1,
"x-faker": {
"fake": ["X1-{{random.alphaNumeric(5)}}-{{random.alphaNumeric(5)}}"]
}
}