From 73f110845ded15853d79e8ef7aea241a9c097622 Mon Sep 17 00:00:00 2001 From: kstich Date: Wed, 4 Oct 2023 11:44:22 -0700 Subject: [PATCH] Add important notice for required contextParams --- .../additional-specs/rules-engine/parameters.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/source-2.0/additional-specs/rules-engine/parameters.rst b/docs/source-2.0/additional-specs/rules-engine/parameters.rst index cc24c2bceb3..3385dc5f201 100644 --- a/docs/source-2.0/additional-specs/rules-engine/parameters.rst +++ b/docs/source-2.0/additional-specs/rules-engine/parameters.rst @@ -281,6 +281,15 @@ bound to the ``linkId`` rule set parameter: } +.. important:: + + If a member marked with the ``@contextParam`` trait is also marked as + :ref:`required `, clients MUST NOT send requests if the + parameter is unset, empty, or exclusively whitespace characters. This + ensures that servers can reliably dispatch to operations based on these + parameters. + + .. _rules-engine-parameters-built-ins: Rules engine built-ins