SpaceTradersAPI / api-docs

The API documentation for the SpaceTraders API
143 stars 36 forks source link

"Getting Started" kinda unclear about how to buy ship #83

Open globalworming opened 11 months ago

globalworming commented 11 months ago

I am currently going through https://docs.spacetraders.io/quickstart/purchase-ship

it states

Look for a waypoint with the SHIPYARD trait. [...] Take note of the symbol for the orbital station waypoint that has a shipyard, which you can use to purchase a mining drone. To view the ships available for purchase at a shipyard, send the following request. You will notice that there is a mining drone available for purchase, which can help you fulfill your starting contract.

so my expectation is

from what I observed, this isn't necessarily true, sometimes the "mining drone" isn't available in the "orbital" but e.g. "moon"

curl 'https://api.spacetraders.io/v2/systems/X1-RA81/waypoints?traits=SHIPYARD' \ --header 'Authorization: Bearer eyJhbGci[...]

[...] "systemSymbol":"X1-RA81", "symbol":"X1-RA81-H59", "type":"MOON", [...]

curl 'https://api.spacetraders.io/v2/systems/X1-RA81/waypoints/X1-RA81-H59/shipyard' \ --header 'Authorization: Bearer eyJhbG[...]

 [...] "data":{"symbol":"X1-RA81-H59", "shipTypes":[{"type": "SHIP_SURVEYOR"}, {"type": "SHIP_MINING_DRONE" [...]

is it intended that any of the shipyards may contain the "mining drone", and if yes, could you please update the "getting started" to make that more clear?

space-admiral commented 11 months ago

Thanks for posting, you are right, the guide needs to be updated with some recent changes to the starting system. Really appreciate you catching this!