docs/Developers: Use CAPI-<endpoint> for gameversion/build

It's the true source of the data, and less fraught with corner cases than
trying to be sure that the Journal-derived values would be correct.
This commit is contained in:
Athanasius 2022-09-27 16:05:49 +01:00
parent d57ab05ee3
commit aa99d3e057
No known key found for this signature in database
GPG Key ID: 8C392035DD80FD62

View File

@ -248,9 +248,13 @@ either `Fileheader` or `LoadGame` as outlined below.
use its value. use its value.
3. If `LoadGame` does not have the field, as with 3.8 Horizons 3. If `LoadGame` does not have the field, as with 3.8 Horizons
clients (up to at least `3.8.0.407`), you **MUST** set the value to clients (up to at least `3.8.0.407`), you **MUST** set the value to
`"CAPI"`. `"CAPI-journal"`.
3. If you are sourcing data from other CAPI endpoints, i.e. for commodity, 3. If you are sourcing data from other CAPI endpoints, i.e. for commodity,
shipyard or outfitting messages, then simply set the values to `"CAPI"`. shipyard or outfitting messages, then simply set the values appropriately as
per the CAPI endpoint the data came from:
1. If it's a commodity message then use `"CAPI-market"`.
2. If it's a shipyard message then use `"CAPI-shipyard"`.
3. If it's an oufitting message then also use `"CAPI-shipyard"`.
--- ---