From 28845d078915e8a45c6ff632e9285c40b41a7728 Mon Sep 17 00:00:00 2001 From: Maria Grimaldi Date: Fri, 20 Dec 2024 16:53:20 +0100 Subject: [PATCH] docs: add note about data stability over time --- docs/how-tos/create-a-new-event.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/how-tos/create-a-new-event.rst b/docs/how-tos/create-a-new-event.rst index 4c64d7da..b931d0c0 100644 --- a/docs/how-tos/create-a-new-event.rst +++ b/docs/how-tos/create-a-new-event.rst @@ -110,6 +110,8 @@ This will help ensure that the event is self-descriptive and self-contained as m .. note:: There has been cases where events also carry other contextual data not directly related to the event but useful for consumers. Although this is not recommended, if you need to include such data, ensure that the reasoning behind it is documented and does not introduce ambiguity. +.. note:: Also consider how relevant is the data to where the event is triggered. Consider whether it could be removed or deprecated in the future so that the event remains consistent and maintainable over time. + Step 5: Implement the Event Definition and Payload ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~