From 91674a4ceb5d88f28da39a150fa608f19b5480ae Mon Sep 17 00:00:00 2001
From: Amri Sannang <amri.sannang@alaress.com.au>
Date: Fri, 6 Jun 2025 09:29:18 +1000
Subject: [PATCH] Add messageParams to release notes [SA-19820]

---
 openapi/components/requestBodies/userNotify.yaml | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/openapi/components/requestBodies/userNotify.yaml b/openapi/components/requestBodies/userNotify.yaml
index 56911707..ca1f55b7 100644
--- a/openapi/components/requestBodies/userNotify.yaml
+++ b/openapi/components/requestBodies/userNotify.yaml
@@ -10,8 +10,22 @@ content:
           type: string
           description: |
             The content of the notification message.
+
+            May contain placeholder values, preceded with a `:` character
+            (e.g. `:placeholderName`): these will be replaced with the
+            corresponding value in `messageParams`.
           example: |
-            Checkout the 22.1 Release notes
+            Checkout the :version Release notes
+        messageParams:
+          type: object
+          additionalProperties:
+            type: string
+          description: |
+            A set of key-value pairs: each key should match a placeholder in
+            `message`, and its corresponding value will replace that placeholder
+            in the final message.
+          example:
+            version: '25.0'
         from:
           type: object
           properties: