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

docs/Developers: Call out that Listeners need to pay attention to Augmentations

Browse Source
This commit is contained in:
Athanasius 2022-05-29 12:05:05 +01:00
parent 2aa605a2b3
commit 70a04a4f77
No known key found for this signature in database
GPG Key ID: AE3E527847057C7D
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Developers.md
View File

@ -435,7 +435,11 @@ data you will first need to zlib-decompress each message. Then you will
have a textual JSON object as per the Schemas.
In general, check the guidance for [Uploading messages](#uploading-messages)
for the expected format of the messages.
for the expected format of the messages. **Pay particular attention to any
schema-specific Augmentations**. Whilst Senders MUST make every effort to
ensure such data is correct it is possible that bugs in either their code, or
the game itself, could mean it is incorrect. Listeners use such data at
their own risk.
Consumers can utilise the `$schemaRef` value to determine which Schema a
particular message is for. There is no need to validate the messages