mirror of
https://github.com/SpaceTradersAPI/api-docs.git
synced 2024-12-25 14:18:07 +01:00
add missing attributes
This commit is contained in:
parent
754b578438
commit
cbcf07190d
@ -2,6 +2,11 @@
|
||||
"type": "object",
|
||||
"description": "A cooldown is a period of time in which a ship cannot perform certain actions.",
|
||||
"properties": {
|
||||
"shipSymbol": {
|
||||
"type": "string",
|
||||
"description": "The symbol of the ship that is on cooldown",
|
||||
"minLength": 1
|
||||
},
|
||||
"totalSeconds": {
|
||||
"type": "integer",
|
||||
"description": "The total duration of the cooldown in seconds",
|
||||
@ -20,6 +25,7 @@
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"shipSymbol",
|
||||
"totalSeconds",
|
||||
"remainingSeconds",
|
||||
"expiration"
|
||||
|
@ -19,6 +19,14 @@
|
||||
"MODULE_SHIELD_GENERATOR_II"
|
||||
]
|
||||
},
|
||||
"capacity": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"range": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
|
@ -25,6 +25,10 @@
|
||||
"description": {
|
||||
"type": "string"
|
||||
},
|
||||
"strength": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"requirements": {
|
||||
"$ref": "./ShipRequirements.json"
|
||||
}
|
||||
|
@ -3,9 +3,13 @@
|
||||
"properties": {
|
||||
"symbol": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"$ref": "./WaypointType.json"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"symbol"
|
||||
"symbol",
|
||||
"type"
|
||||
]
|
||||
}
|
@ -60,7 +60,7 @@
|
||||
"paths": {
|
||||
"/register": {
|
||||
"post": {
|
||||
"description": "Creates a new agent and ties it to a temporary Account. Use `COMMERCE_REPUBLIC` as your starting faction if you don't know any other factions to choose from.\n\nThe agent symbol is a 4-8 character string that will represent your agent. This symbol will prefix the symbol of every ship you own. Agent symbols will be cast to all uppercase characters.\n\nA new agent will be granted an authorization token, a contract with their starting faction, a command ship with a jump drive, and one hundred thousand credits.\n\n> #### Keep your token safe and secure\n>\n> Save your token during the alpha phase. There is no way to regenerate this token without starting a new agent. In the future you will be able to generate and manage your tokens from the SpaceTraders website.\n\nYou can accept your contract using the `/my/contracts/{contractId}/accept` endpoint. You will want to navigate your command ship to a nearby asteroid field waypoint, and execute the `/my/ships/{shipSymbol}/accept` endpoint to mine various types of ores and minerals.\n\nReturn to the contract destination and execute the `/my/ships/{shipSymbol}/deliver` endpoint to deposit goods into the contract.\n\nWhen your contract is fulfilled, you can call `/my/contracts/{contractId}/fulfill` to retrieve payment.",
|
||||
"description": "Creates a new agent and ties it to a temporary Account.\n\nThe agent symbol is a 4-8 character string that will represent your agent. This symbol will prefix the symbol of every ship you own. Agent symbols will be cast to all uppercase characters.\n\nA new agent will be granted an authorization token, a contract with their starting faction, a command ship with a jump drive, and one hundred thousand credits.\n\n> #### Keep your token safe and secure\n>\n> Save your token during the alpha phase. There is no way to regenerate this token without starting a new agent. In the future you will be able to generate and manage your tokens from the SpaceTraders website.\n\nYou can accept your contract using the `/my/contracts/{contractId}/accept` endpoint. You will want to navigate your command ship to a nearby asteroid field and execute the `/my/ships/{shipSymbol}/extract` endpoint to mine various types of ores and minerals.\n\nReturn to the contract destination and execute the `/my/ships/{shipSymbol}/deliver` endpoint to deposit goods into the contract.\n\nWhen your contract is fulfilled, you can call `/my/contracts/{contractId}/fulfill` to retrieve payment.",
|
||||
"operationId": "register",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
|
Loading…
Reference in New Issue
Block a user