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

schemas/README: State that schema files trump their README

Browse Source
This commit is contained in:
Athanasius 2022-01-29 17:24:21 +00:00
parent d802448e4c
commit da109f85e7
No known key found for this signature in database
GPG Key ID: AE3E527847057C7D
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -217,7 +217,16 @@ For example, a shipyard message, version 2, might look like:
```
### Contents of `message`
Every message MUST comply with the Schema its `$schemaRef` value cites.
Every message MUST comply with the Schema its `$schemaRef` value cites. Each
Schema file should have a matching `<schema>-README.md` file in the project
root `schemas/` directory. Always consult this so that you're aware of any
Schema-specific requirements.
The Schema file, `<schema>-v<version>.json`, is considered the authority on
the format of messages for that Schema. If anything in the accompanying
documentation is in disagreement with this then please
[open an issue on GitHub](https://github.com/EDCD/EDDN/issues/new/choose)
so that we can investigate and correct, or clarify, as necessary.
Apart from short time windows during deployment of a new version the live
EDDN service should always be using