doc: update badges documentation (from aci.documentation) (#171)

raccoongang · May 16, 2024 · 89a4662 · 89a4662
1 parent 8dee580
commit 89a4662
Show file tree

Hide file tree

Showing 12 changed files with 195 additions and 164 deletions.
diff --git a/docs/_static/images/badges/badges-admin-data-rules.png b/docs/_static/images/badges/badges-admin-data-rules.png
diff --git a/docs/_static/images/badges/badges-admin-requirement-rules.png b/docs/_static/images/badges/badges-admin-requirement-rules.png
diff --git a/docs/_static/images/badges/badges-admin-rules-group.png b/docs/_static/images/badges/badges-admin-rules-group.png
diff --git a/docs/_static/images/badges/badges-admin-template-requirements.png b/docs/_static/images/badges/badges-admin-template-requirements.png
diff --git a/docs/_static/images/badges/badges-award-sequence.png b/docs/_static/images/badges/badges-award-sequence.png
diff --git a/docs/_static/images/badges/badges-revoke-sequence.png b/docs/_static/images/badges/badges-revoke-sequence.png
diff --git a/docs/_static/images/badges/badges-setup-sequence.png b/docs/_static/images/badges/badges-setup-sequence.png
diff --git a/docs/badges/configuration.rst b/docs/badges/configuration.rst
@@ -92,9 +92,12 @@ Description
 Group
 ~~~~~
 
-Optional field for badge requirement.
+Optional configuration (by default each badge requirement is assigned a separate Group).
 
-Allows mark 2 or more badge requirements as a group. Requirements group is fulfilled if any of its requirements is fulfilled ("OR" logic is applied inside a group).
+Allows putting 2 or more badge requirements as a Group.
+Requirements group is fulfilled if any of its requirements is fulfilled.
+
+    "OR" logic is applied inside a Group.
 
 .. image:: ../_static/images/badges/badges-admin-rules-group.png
         :alt: Badge requirement rules group
@@ -123,9 +126,17 @@ All key paths are generated based on the event type specified for the parent Bad
 .. image:: ../_static/images/badges/badges-admin-data-rules.png
         :alt: Badge requirement data rules
 
-1. **Key path** - payload path to the target attribute;
-2. **Operator** - how to compare expected and actual values;
-3. **Expected value** - an expected value for the target attribute;
+1. **Key path** - payload path to the target attribute
+    - dot-separated string;
+    - each event type has its unique pre-defined set of key paths;
+2. **Operator** - comparison operation to apply between expected and actual values;
+    - available operators: (payload)
+        -  ``"="`` (equals);
+        - ``"!="`` (not equals);
+3. **Expected value** - an expected value for the target attribute
+    - payload boolean positive values allowed: ``"true", "True", "yes", "Yes", "+"``;
+    - payload boolean negative values allowed: ``"false", "False", "no", "No", "-"``;
+
 
 Please, see `configuration examples`_ for clarity.