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

Merge pull request #59 from Shushishtok/updated-descriptions

Browse Source 
Updated descriptions
This commit is contained in:
SpaceAdmiral 2023-06-10 09:29:27 -07:00 committed by GitHub
commit c83c8ec844
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
34 changed files with 658 additions and 501 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
models/Agent.json
View File

@ -1,14 +1,16 @@
{
"description": "",
"description": "Agent details.",
"type": "object",
"properties": {
"accountId": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "Account ID that is tied to this agent."
},
"symbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "Symbol of the agent."
},
"headquarters": {
"type": "string",
@ -33,4 +35,4 @@
"credits",
"startingFaction"
]
}
}

9
models/Chart.json
View File

@ -3,14 +3,17 @@
"description": "The chart of a system or waypoint, which makes the location visible to other agents.",
"properties": {
"waypointSymbol": {
"type": "string"
"type": "string",
"description": "The symbol of the waypoint."
},
"submittedBy": {
"type": "string"
"type": "string",
"description": "The agent that submitted the chart for this waypoint."
},
"submittedOn": {
"type": "string",
"format": "date-time"
"format": "date-time",
"description": "The time the chart for this waypoint was submitted."
}
}
}

16
models/ConnectedSystem.json
View File

@ -1,14 +1,15 @@
{
"description": "",
"type": "object",
"properties": {
"symbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "The symbol of the system."
},
"sectorSymbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "The sector of this system."
},
"type": {
"$ref": "./SystemType.json"
@ -18,13 +19,16 @@
"description": "The symbol of the faction that owns the connected jump gate in the system."
},
"x": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the x axis."
},
"y": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the y axis."
},
"distance": {
"type": "integer"
"type": "integer",
"description": "The distance of this system to the connected Jump Gate."
}
},
"required": [

11
models/Contract.json
View File

@ -1,10 +1,11 @@
{
"description": "",
"description": "Contract details.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "ID of the contract."
},
"factionSymbol": {
"type": "string",
@ -17,10 +18,12 @@
"PROCUREMENT",
"TRANSPORT",
"SHUTTLE"
]
],
"description": "Type of contract."
},
"terms": {
"$ref": "./ContractTerms.json"
"$ref": "./ContractTerms.json",
"description": "The terms to fulfill the contract."
},
"accepted": {
"type": "boolean",

5
models/ContractTerms.json
View File

@ -1,5 +1,6 @@
{
"type": "object",
"description": "Terms of the contract needed to fulfill it.",
"properties": {
"deadline": {
"type": "string",
@ -7,10 +8,12 @@
"description": "The deadline for the contract."
},
"payment": {
"$ref": "./ContractPayment.json"
"$ref": "./ContractPayment.json",
"description": "Payments for the contract."
},
"deliver": {
"type": "array",
"description": "The cargo that needs to be delivered to fulfill the contract.",
"items": {
"$ref": "./ContractDeliverGood.json"
}

8
models/Extraction.json
View File

@ -1,13 +1,15 @@
{
"description": "",
"description": "Extraction details.",
"type": "object",
"properties": {
"shipSymbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "Symbol of the ship that executed the extraction."
},
"yield": {
"$ref": "./ExtractionYield.json"
"$ref": "./ExtractionYield.json",
"description": "Yields from the extract operation."
}
},
"required": [

5
models/ExtractionYield.json
View File

@ -1,9 +1,10 @@
{
"type": "object",
"description": "A yield from the extraction operation.",
"properties": {
"symbol": {
"type": "string",
"minLength": 1
"$ref": "./TradeSymbol.json",
"description": "Symbol of the good that was extracted."
},
"units": {
"type": "integer",

16
models/Faction.json
View File

@ -1,25 +1,29 @@
{
"description": "",
"description": "Faction details.",
"type": "object",
"properties": {
"symbol": {
"type": "string",
"minLength": 1
"$ref": "./FactionSymbols.json",
"description": "Faction symbol."
},
"name": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "Name of the faction."
},
"description": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "Description of the faction."
},
"headquarters": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "The waypoint in which the faction's HQ is located in."
},
"traits": {
"type": "array",
"description": "List of traits that define this faction.",
"items": {
"$ref": "./FactionTrait.json"
}

29
models/FactionSymbols.json Normal file
View File

@ -0,0 +1,29 @@
{
"type": "string",
"description": "Faction symbol.",
"minLength": 1,
"enum": [
"COSMIC",
"VOID",
"GALACTIC",
"QUANTUM",
"DOMINION",
"ASTRO",
"CORSAIRS",
"OBSIDIAN",
"AEGIS",
"UNITED",
"SOLITARY",
"COBALT",
"OMEGA",
"ECHO",
"LORDS",
"CULT",
"ANCIENTS",
"SHADOW",
"ETHEREAL"
],
"examples": [
"COSMIC"
]
}

3
models/MarketTransaction.json
View File

@ -51,5 +51,6 @@
"pricePerUnit",
"totalPrice",
"timestamp"
]
],
"description": "Result of a transaction with a market."
}

45
models/Meta.json
View File

@ -1,27 +1,36 @@
{
"description": "",
"description": "Meta details for pagination.",
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"page": {
"type": "integer"
},
"limit": {
"type": "integer"
}
},
"required": [
"total",
"page",
"limit"
],
"x-examples": {
"example-1": {
"total": 6,
"page": 1,
"limit": 20
}
}
},
"properties": {
"total": {
"type": "integer",
"description": "Shows the total amount of items of this kind that exist.",
"minimum": 0
},
"page": {
"type": "integer",
"default": 1,
"description": "A page denotes an amount of items, offset from the first item. Each page holds an amount of items equal to the `limit`.",
"minimum": 1
},
"limit": {
"type": "integer",
"default": 10,
"description": "The amount of items in each page. Limits how many items can be fetched at once.",
"minimum": 1,
"maximum": 20
}
},
"required": [
"total",
"page",
"limit"
]
}

23
models/ScannedShip.json
View File

@ -17,7 +17,8 @@
"description": "The frame of the ship.",
"properties": {
"symbol": {
"type": "string"
"type": "string",
"description": "The symbol of the frame."
}
},
"required": [
@ -29,7 +30,8 @@
"description": "The reactor of the ship.",
"properties": {
"symbol": {
"type": "string"
"type": "string",
"description": "The symbol of the reactor."
}
},
"required": [
@ -39,23 +41,26 @@
"engine": {
"type": "object",
"description": "The engine of the ship.",
"properties": {
"symbol": {
"type": "string"
}
},
"required": [
"symbol"
]
],
"properties": {
"symbol": {
"type": "string",
"description": "The symbol of the engine."
}
}
},
"mounts": {
"type": "array",
"description": "List of mounts installed in the ship.",
"items": {
"type": "object",
"description": "A mount on the ship.",
"properties": {
"symbol": {
"type": "string"
"type": "string",
"description": "The symbol of the mount."
}
},
"required": [

17
models/ScannedSystem.json
View File

@ -1,26 +1,31 @@
{
"description": "",
"description": "Details of a system was that scanned.",
"type": "object",
"properties": {
"symbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "Symbol of the system."
},
"sectorSymbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "Symbol of the system's sector."
},
"type": {
"$ref": "./SystemType.json"
},
"x": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the x axis."
},
"y": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the y axis."
},
"distance": {
"type": "integer"
"type": "integer",
"description": "The system's distance from the scanning ship."
}
},
"required": [

15
models/ScannedWaypoint.json
View File

@ -1,26 +1,31 @@
{
"description": "A waypoint is a location that ships can travel to such as a Planet, Moon or Space Station.",
"description": "A waypoint that was scanned by a ship.",
"type": "object",
"properties": {
"symbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "Symbol of the waypoint."
},
"type": {
"$ref": "./WaypointType.json"
},
"systemSymbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "Symbol of the system."
},
"x": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the x axis."
},
"y": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the y axis."
},
"orbitals": {
"type": "array",
"description": "List of waypoints that orbit this waypoint.",
"items": {
"$ref": "./WaypointOrbital.json"
}

6
models/Ship.json
View File

@ -1,10 +1,10 @@
{
"description": "A ship",
"description": "Ship details.",
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The globally unique identifier of the ship in the following format: `[AGENT_SYMBOL]_[HEX_ID]`"
"description": "The globally unique identifier of the ship in the following format: `[AGENT_SYMBOL]-[HEX_ID]`"
},
"registration": {
"$ref": "./ShipRegistration.json"
@ -26,12 +26,14 @@
},
"modules": {
"type": "array",
"description": "Modules installed in this ship.",
"items": {
"$ref": "./ShipModule.json"
}
},
"mounts": {
"type": "array",
"description": "Mounts installed in this ship.",
"items": {
"$ref": "./ShipMount.json"
}

3
models/ShipCargo.json
View File

@ -23,5 +23,6 @@
"capacity",
"units",
"inventory"
]
],
"description": "Ship cargo details."
}

14
models/ShipEngine.json
View File

@ -9,20 +9,24 @@
"ENGINE_ION_DRIVE_I",
"ENGINE_ION_DRIVE_II",
"ENGINE_HYPER_DRIVE_I"
]
],
"description": "The symbol of the engine."
},
"name": {
"type": "string"
"type": "string",
"description": "The name of the engine."
},
"description": {
"type": "string"
"type": "string",
"description": "The description of the engine."
},
"condition": {
"$ref": "./ShipCondition.json"
},
"speed": {
"type": "integer",
"minimum": 1
"minimum": 1,
"description": "The speed stat of this engine. The higher the speed, the faster a ship can travel from one point to another. Reduces the time of arrival when navigating the ship."
},
"requirements": {
"$ref": "./ShipRequirements.json"
@ -35,4 +39,4 @@
"speed",
"requirements"
]
}
}

18
models/ShipFrame.json
View File

@ -20,28 +20,34 @@
"FRAME_DESTROYER",
"FRAME_CRUISER",
"FRAME_CARRIER"
]
],
"description": "Symbol of the frame."
},
"name": {
"type": "string"
"type": "string",
"description": "Name of the frame."
},
"description": {
"type": "string"
"type": "string",
"description": "Description of the frame."
},
"condition": {
"$ref": "./ShipCondition.json"
},
"moduleSlots": {
"type": "integer",
"minimum": 0
"minimum": 0,
"description": "The amount of slots that can be dedicated to modules installed in the ship. Each installed module take up a number of slots, and once there are no more slots, no new modules can be installed."
},
"mountingPoints": {
"type": "integer",
"minimum": 0
"minimum": 0,
"description": "The amount of slots that can be dedicated to mounts installed in the ship. Each installed mount takes up a number of points, and once there are no more points remaining, no new mounts can be installed."
},
"fuelCapacity": {
"type": "integer",
"minimum": 0
"minimum": 0,
"description": "The maximum amount of fuel that can be stored in this ship. When refueling, the ship will be refueled to this amount."
},
"requirements": {
"$ref": "./ShipRequirements.json"

1
models/ShipFuel.json
View File

@ -14,6 +14,7 @@
},
"consumed": {
"type": "object",
"description": "An object that only shows up when an action has consumed fuel in the process. Shows the fuel consumption data.",
"properties": {
"amount": {
"type": "integer",

16
models/ShipModule.json
View File

@ -22,21 +22,26 @@
"MODULE_WARP_DRIVE_III",
"MODULE_SHIELD_GENERATOR_I",
"MODULE_SHIELD_GENERATOR_II"
]
],
"description": "The symbol of the module."
},
"capacity": {
"type": "integer",
"minimum": 0
"minimum": 0,
"description": "Modules that provide capacity, such as cargo hold or crew quarters will show this value to denote how much of a bonus the module grants."
},
"range": {
"type": "integer",
"minimum": 0
"minimum": 0,
"description": "Modules that have a range will such as a sensor array show this value to denote how far can the module reach with its capabilities."
},
"name": {
"type": "string"
"type": "string",
"description": "Name of this module."
},
"description": {
"type": "string"
"type": "string",
"description": "Description of this module."
},
"requirements": {
"$ref": "./ShipRequirements.json"
@ -45,6 +50,7 @@
"required": [
"symbol",
"name",
"description",
"requirements"
]
}

13
models/ShipMount.json
View File

@ -20,20 +20,25 @@
"MOUNT_LASER_CANNON_I",
"MOUNT_MISSILE_LAUNCHER_I",
"MOUNT_TURRET_I"
]
],
"description": "Symbo of this mount."
},
"name": {
"type": "string"
"type": "string",
"description": "Name of this mount."
},
"description": {
"type": "string"
"type": "string",
"description": "Description of this mount."
},
"strength": {
"type": "integer",
"minimum": 0
"minimum": 0,
"description": "Mounts that have this value, such as mining lasers, denote how powerful this mount's capabilities are."
},
"deposits": {
"type": "array",
"description": "Mounts that have this value denote what goods can be produced from using the mount.",
"items": {
"type": "string",
"enum": [

12
models/ShipNavRouteWaypoint.json
View File

@ -4,20 +4,24 @@
"properties": {
"symbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "The symbol of the waypoint."
},
"type": {
"$ref": "./WaypointType.json"
},
"systemSymbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "The symbol of the system the waypoint is in."
},
"x": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the x axis."
},
"y": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the y axis."
}
},
"required": [

12
models/ShipReactor.json
View File

@ -10,20 +10,24 @@
"REACTOR_FISSION_I",
"REACTOR_CHEMICAL_I",
"REACTOR_ANTIMATTER_I"
]
],
"description": "Symbol of the reactor."
},
"name": {
"type": "string"
"type": "string",
"description": "Name of the reactor."
},
"description": {
"type": "string"
"type": "string",
"description": "Description of the reactor."
},
"condition": {
"$ref": "./ShipCondition.json"
},
"powerOutput": {
"type": "integer",
"minimum": 1
"minimum": 1,
"description": "The amount of power provided by this reactor. The more power a reactor provides to the ship, the lower the cooldown it gets when using a module or mount that taxes the ship's power."
},
"requirements": {
"$ref": "./ShipRequirements.json"

2
models/ShipType.json
View File

@ -1,5 +1,5 @@
{
"description": "",
"description": "Type of ship",
"type": "string",
"enum": [
"SHIP_PROBE",

3
models/ShipyardTransaction.json
View File

@ -1,5 +1,6 @@
{
"type": "object",
"description": "Results of a transaction with a shipyard.",
"properties": {
"waypointSymbol": {
"type": "string",
@ -7,7 +8,7 @@
},
"shipSymbol": {
"type": "string",
"description": "The symbol of the ship that was purchased."
"description": "The symbol of the ship that was the subject of the transaction."
},
"price": {
"type": "integer",

15
models/System.json
View File

@ -1,32 +1,37 @@
{
"description": "",
"type": "object",
"properties": {
"symbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "The symbol of the system."
},
"sectorSymbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "The symbol of the sector."
},
"type": {
"$ref": "./SystemType.json"
},
"x": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the x axis."
},
"y": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the y axis."
},
"waypoints": {
"type": "array",
"description": "Waypoints in this system.",
"items": {
"$ref": "./SystemWaypoint.json"
}
},
"factions": {
"type": "array",
"description": "Factions that control this system.",
"items": {
"$ref": "./SystemFaction.json"
}

3
models/SystemFaction.json
View File

@ -3,7 +3,8 @@
"properties": {
"symbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "The symbol of the faction."
}
},
"required": [

9
models/SystemWaypoint.json
View File

@ -2,16 +2,19 @@
"type": "object",
"properties": {
"symbol": {
"type": "string"
"type": "string",
"description": "The symbol of the waypoint."
},
"type": {
"$ref": "./WaypointType.json"
},
"x": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the x axis."
},
"y": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the y axis."
}
},
"required": [

7
models/TradeGood.json
View File

@ -1,14 +1,17 @@
{
"type": "object",
"description": "A good that can be traded for other goods or currency.",
"properties": {
"symbol": {
"$ref": "./TradeSymbol.json"
},
"name": {
"type": "string"
"type": "string",
"description": "The name of the good."
},
"description": {
"type": "string"
"type": "string",
"description": "The description of the good."
}
},
"required": [

3
models/TradeSymbol.json
View File

@ -111,5 +111,6 @@
"MOUNT_LASER_CANNON_I",
"MOUNT_MISSILE_LAUNCHER_I",
"MOUNT_TURRET_I"
]
],
"description": "The good's symbol."
}

13
models/Waypoint.json
View File

@ -4,23 +4,28 @@
"properties": {
"symbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "Symbol fo the waypoint."
},
"type": {
"$ref": "./WaypointType.json"
},
"systemSymbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "The symbol of the system this waypoint belongs to."
},
"x": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the x axis."
},
"y": {
"type": "integer"
"type": "integer",
"description": "Position in the universe in the Y axis."
},
"orbitals": {
"type": "array",
"description": "Waypoints that orbit this waypoint.",
"items": {
"$ref": "./WaypointOrbital.json"
}

4
models/WaypointFaction.json
View File

@ -1,9 +1,9 @@
{
"type": "object",
"description": "The faction that controls the waypoint.",
"properties": {
"symbol": {
"type": "string",
"minLength": 1
"$ref": "./FactionSymbols.json"
}
},
"required": [

3
models/WaypointOrbital.json
View File

@ -4,7 +4,8 @@
"properties": {
"symbol": {
"type": "string",
"minLength": 1
"minLength": 1,
"description": "The symbol of the orbiting waypoint."
}
},
"required": [

790
reference/SpaceTraders.json
View File

File diff suppressed because it is too large Load Diff