mirror of
https://github.com/SpaceTradersAPI/api-docs.git
synced 2024-11-14 22:30:51 +01:00
Merge branch 'main' into v2.1
This commit is contained in:
commit
108c51ab9d
@ -1,9 +1,3 @@
|
|||||||
# Announcements
|
|
||||||
|
|
||||||
The server reset on 2023-05-13 at 11:00AM PST to accomodate new players and push important fixes to the game.
|
|
||||||
|
|
||||||
We are also working on a detailed plan for how we manage resets in the future and will communicate that plan in the docs and on Discord when it is ready.
|
|
||||||
|
|
||||||
# Getting Started
|
# Getting Started
|
||||||
|
|
||||||
SpaceTraders is an API-based game where you acquire and manage a fleet of ships to explore, trade, and fight your way across the galaxy.
|
SpaceTraders is an API-based game where you acquire and manage a fleet of ships to explore, trade, and fight your way across the galaxy.
|
||||||
|
@ -2,8 +2,16 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"symbol": {
|
"symbol": {
|
||||||
|
"$ref": "./TradeSymbol.json"
|
||||||
|
},
|
||||||
|
"type": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "The symbol of the trade good."
|
"description": "The type of trade good (export, import, or exchange).",
|
||||||
|
"enum": [
|
||||||
|
"EXPORT",
|
||||||
|
"IMPORT",
|
||||||
|
"EXCHANGE"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
|
@ -3,8 +3,7 @@
|
|||||||
"description": "The type of cargo item and the number of units.",
|
"description": "The type of cargo item and the number of units.",
|
||||||
"properties": {
|
"properties": {
|
||||||
"symbol": {
|
"symbol": {
|
||||||
"type": "string",
|
"$ref": "./TradeSymbol.json"
|
||||||
"description": "The unique identifier of the cargo item type."
|
|
||||||
},
|
},
|
||||||
"name": {
|
"name": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
|
@ -115,7 +115,8 @@
|
|||||||
"MOUNT_MINING_LASER_III",
|
"MOUNT_MINING_LASER_III",
|
||||||
"MOUNT_LASER_CANNON_I",
|
"MOUNT_LASER_CANNON_I",
|
||||||
"MOUNT_MISSILE_LAUNCHER_I",
|
"MOUNT_MISSILE_LAUNCHER_I",
|
||||||
"MOUNT_TURRET_I"
|
"MOUNT_TURRET_I",
|
||||||
|
"FAB_MATS"
|
||||||
],
|
],
|
||||||
"description": "The good's symbol."
|
"description": "The good's symbol."
|
||||||
}
|
}
|
||||||
|
@ -3309,7 +3309,7 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"post": {
|
"post": {
|
||||||
"description": "Negotiate a new contract with the HQ.\n\nIn order to negotiate a new contract, an agent must not have ongoing or offered contracts over the allowed maximum amount. Currently the maximum contracts an agent can have at a time is 1.\n\nOnce a contract is negotiated, it is added to the list of contracts offered to the agent, which the agent can then accept. \n\nThe ship must be present at a faction's HQ waypoint to negotiate a contract with that faction.",
|
"description": "Negotiate a new contract with the HQ.\n\nIn order to negotiate a new contract, an agent must not have ongoing or offered contracts over the allowed maximum amount. Currently the maximum contracts an agent can have at a time is 1.\n\nOnce a contract is negotiated, it is added to the list of contracts offered to the agent, which the agent can then accept. \n\nThe ship must be present at any waypoint with a faction present to negotiate a contract with that faction.",
|
||||||
"operationId": "negotiateContract",
|
"operationId": "negotiateContract",
|
||||||
"responses": {
|
"responses": {
|
||||||
"201": {
|
"201": {
|
||||||
|
Loading…
Reference in New Issue
Block a user