third-party-mirrors/EDDN
1
0
Fork 0
mirror of https://github.com/EDCD/EDDN.git synced 2025-04-19 01:57:40 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs/Developers: Don't make it look like advice is about gamebuild

Browse Source 
* The ordered-list advice is for `gameversion`, not `gamebuild`.  So move
  the latter mention below that list.
* Also mention `fcmaterials_capi` comes from `market` endpoint.
This commit is contained in:
Athanasius 2022-11-25 15:39:11 +00:00
parent fecaf76e92
commit b00b3737d2
No known key found for this signature in database
GPG Key ID: 772697E181BB2767
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/Developers.md
View File

@ -239,9 +239,6 @@ Where present in the data source the `gameversion` value **MUST** come from
the field of that name in the data source, i.e. from either `Fileheader` or the field of that name in the data source, i.e. from either `Fileheader` or
`LoadGame` as outlined below. `LoadGame` as outlined below.
For `gamebuild` you **MUST** use the value of the `build` field in the data
source.
1. If you are using Journal files directly then you **MUST** use the value 1. If you are using Journal files directly then you **MUST** use the value
from the`Fileheader` event. from the`Fileheader` event.
2. If you are using the CAPI `/journal` endpoint to retrieve and process 2. If you are using the CAPI `/journal` endpoint to retrieve and process
@ -259,10 +256,15 @@ source.
1. If it's a commodity message, then use `"CAPI-market"`. 1. If it's a commodity message, then use `"CAPI-market"`.
2. If it's a shipyard message, then use `"CAPI-shipyard"`. 2. If it's a shipyard message, then use `"CAPI-shipyard"`.
3. If it's an oufitting message, then also use `"CAPI-shipyard"`. 3. If it's an oufitting message, then also use `"CAPI-shipyard"`.
4. If it's an fcmaterials_capi message, then use "CAPI-market", as the
data comes from that endpoint.
Again, if your code architecture doesn't allow for signalling that the data Again, if your code architecture doesn't allow for signalling that the data
source was CAPI, then you MAY set it to `""` instead. source was CAPI, then you MAY set it to `""` instead.
For `gamebuild` you **MUST** use the value of the `build` field in the data
source, if available, else send as `""`.
For emphasis, **if you cannot set a data-source value, or an appropriate For emphasis, **if you cannot set a data-source value, or an appropriate
`"CAPI-..."` value then you **MUST** still send the field with an empty string `"CAPI-..."` value then you **MUST** still send the field with an empty string
value. value.