Documentation bug for PI endpoint
Bug
This is a documentation bug. Under the /characters/{character_id}/planets/{planet_id}/ endpoint. There is the following note:
Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met.
That is incorrect and is causing confusion. Viewing the colony through the client does not recalculate the information. Making any change to the colony does.
Some examples:
- Open the colony in-game, do nothing, close the colony, wait for cache expiry, the ESI response will not change, despite what the note says.
- Do not open a colony in-game, but open the UI for a Customs Office/Skyhook and transfer some commodities between it and a Launchpad, wait for cache expiry, the ESI response will update even though the colony was not viewed, despite what the note says.
- Do not open a colony in-game, but use the new Restart Extractors button from the Plantary Industry window, wait for cache expiry, the ESI response will update even though the colony was not viewed, despite what the note says.
I propose to update the note to:
Note: Planetary information is only recalculated when the colony is modified through client. This includes making edits to the layout, restarting extractors, transferring commodities to/from the orbit, or any other action that changes the state of the colony. Information will not update until this criteria is met.