diff --git a/docs/quickstart.md b/docs/quickstart.md index 46f1b40..ee5ebdf 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -10,7 +10,7 @@ You can use the API to automate your fleet or build a client for you and other p > #### Alpha 2.0 > -> The game is a work in progress. We are currently in the alpha stage of development. We are actively working on the game and adding new features. If you have any questions or feedback, please join our [Discord](https://discord.gg/8YQZ3Z) and let us know. +> The game is a work in progress. We are currently in the alpha stage of development. We are actively working on the game and adding new features. If you have any questions or feedback, please join our [Discord](https://discord.gg/QB8zyNW7RH) and let us know. ### Game Overview @@ -595,7 +595,7 @@ Find a waypoint with a type of ASTEROID_FIELD and navigate your command ship to ```bash https -A bearer -a $apiToken POST $apiUrl/my/ships/$shipSymbol/navigate \ - waypointSymbol==$waypointSymbol + waypointSymbol=$waypointSymbol ``` ```json @@ -643,7 +643,7 @@ Note the route departure and destination details. The departure is the waypoint You will also notice that your ship has consumed fuel upon navigation. You will want to refuel your ship whenever possible or risk getting stranded in space. Once your ship arrives at it's destination, you can refuel it using the following endpoint. ```bash -https POST api.spacetraders.io/my/ships/$shipSymbol/refuel +https -A bearer -a $apiToken POST api.spacetraders.io/my/ships/$shipSymbol/refuel ``` ```json @@ -942,13 +942,11 @@ https -A bearer -a $apiToken POST $apiUrl/my/ships/$shipSymbol/sell \ If you want to purchase any goods from the market, you can use the following endpoint. -````bash - ```bash https -A bearer -a $apiToken POST $apiUrl/my/ships/$shipSymbol/purchase \ symbol=$tradeSymbol \ units=10 -```` +``` ### Purchase Ships diff --git a/models/ScannedShip.json b/models/ScannedShip.json index d785295..7588a89 100644 --- a/models/ScannedShip.json +++ b/models/ScannedShip.json @@ -4,8 +4,7 @@ "properties": { "symbol": { "type": "string", - "description": "The globally unique identifier of the ship in the following format: `[AGENT_SYMBOL]_[HEX_ID]`", - "minLength": 8 + "description": "The globally unique identifier of the ship." }, "registration": { "$ref": "./ShipRegistration.json" @@ -14,18 +13,54 @@ "$ref": "./ShipNav.json" }, "frame": { - "$ref": "./ShipFrame.json" + "type": "object", + "description": "The frame of the ship.", + "properties": { + "symbol": { + "type": "string" + } + }, + "required": [ + "symbol" + ] }, "reactor": { - "$ref": "./ShipReactor.json" + "type": "object", + "description": "The reactor of the ship.", + "properties": { + "symbol": { + "type": "string" + } + }, + "required": [ + "symbol" + ] }, "engine": { - "$ref": "./ShipEngine.json" + "type": "object", + "description": "The engine of the ship.", + "properties": { + "symbol": { + "type": "string" + } + }, + "required": [ + "symbol" + ] }, "mounts": { "type": "array", "items": { - "$ref": "./ShipMount.json" + "type": "object", + "description": "A mount on the ship.", + "properties": { + "symbol": { + "type": "string" + } + }, + "required": [ + "symbol" + ] } } }, @@ -33,9 +68,6 @@ "symbol", "registration", "nav", - "frame", - "reactor", - "engine", - "mounts" + "engine" ] } \ No newline at end of file diff --git a/reference/SpaceTraders.json b/reference/SpaceTraders.json index de6c34a..7170af5 100644 --- a/reference/SpaceTraders.json +++ b/reference/SpaceTraders.json @@ -352,7 +352,7 @@ }, "/systems/{systemSymbol}/waypoints/{waypointSymbol}/market": { "get": { - "description": "Retrieve imports, exports and exchange data from a marketplace. Imports can be sold, exports can be purchased, and exchange trades can be purchased or sold.\n\nMarket data is only available if you have a ship at the location, or the location is charted and has a communications relay deployed.\n\nSee `/my/ships/{shipSymbol}/deploy` for deploying relays at a location.", + "description": "Retrieve imports, exports and exchange data from a marketplace. Imports can be sold, exports can be purchased, and exchange goods can be purchased or sold. Send a ship to the waypoint to access trade good prices and recent transactions.", "operationId": "get-market", "responses": { "200": {