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

schemas/README: Point out the status of gameversion/build in main README

Browse Source
This commit is contained in:
Athanasius 2022-11-23 17:50:15 +00:00
parent f8245d8bc2
commit fecaf76e92
No known key found for this signature in database
GPG Key ID: 772697E181BB2767
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
schemas/README-EDDN-schemas.md
View File

@ -54,6 +54,16 @@ contents all Schemas specify a top-level JSON Object with the data:
relevant README file within this documentation, e.g.
[codexentry-README.md](./codexentry-README.md).
Whilst currently (2022-11-23) the `gameversion` and `gamebuild` fields in the
message `header` aren't yet mandatory in the sense of what's in the schema
definitions, all Senders are **strongly encouraged** to send them.
Indeed, the per-schema documentation, for every schema now states:
#### gameversion and gamebuild
You **MUST** always set these as per [the relevant section](../docs/Developers.md#gameversions-and-gamebuild)
of the Developers' documentation.
### General EDDN message outline
Each `message` object must have, at bare minimum: