From 70a04a4f771483c25209ecd9014b525265049b84 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Sun, 29 May 2022 12:05:05 +0100 Subject: [PATCH] docs/Developers: Call out that Listeners need to pay attention to Augmentations --- docs/Developers.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/Developers.md b/docs/Developers.md index 6170e6b..247e381 100644 --- a/docs/Developers.md +++ b/docs/Developers.md @@ -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