feat: add optional label for helpLink component (#939)

* feat: add optional label for helpLink component * fix: align new lines * test: update smoke test --------- Co-authored-by: Artem Rys <rysartem@gmail.com>
splunk · Nov 6, 2023 · e3a9b40 · e3a9b40
1 parent 78433fe
commit e3a9b40
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 3 deletions.
diff --git a/splunk_add_on_ucc_framework/global_config_validator.py b/splunk_add_on_ucc_framework/global_config_validator.py
@@ -331,7 +331,8 @@ def _validate_entity_duplicates(self, entity: List[Dict[str, Any]]) -> None:
         fields, labels = [], []
         for _entity in entity:
             fields.append(_entity["field"].lower())
-            labels.append(_entity["label"].lower())
+            if "label" in _entity:
+                labels.append(_entity["label"].lower())
             options = _entity.get("options")
             if options and options.get("autoCompleteFields"):
                 self._validate_autoCompleteFields_duplicates(

diff --git a/splunk_add_on_ucc_framework/schema/schema.json b/splunk_add_on_ucc_framework/schema/schema.json
@@ -376,7 +376,15 @@
           }
         }
       },
-      "required": ["field", "label", "type"],
+      "anyOf": [
+        {
+          "properties": {
+            "type": { "const": "helpLink" }
+          },
+          "required": ["field", "type"]
+        },
+        { "required": ["field", "label", "type"] }
+      ],      
       "additionalProperties": false
     },
     "ConfigurationPage": {

diff --git a/...obal_config_everything/Splunk_TA_UCCExample/README/splunk_ta_uccexample_account.conf.spec b/...obal_config_everything/Splunk_TA_UCCExample/README/splunk_ta_uccexample_account.conf.spec
@@ -5,6 +5,8 @@ account_checkbox =
 account_radio = 
 account_multiple_select = 
 example_help_link = 
+config1_help_link = 
+config2_help_link = 
 username = 
 password = 
 token = 

diff --git a/...tput_global_config_everything/Splunk_TA_UCCExample/bin/splunk_ta_uccexample_rh_account.py b/...tput_global_config_everything/Splunk_TA_UCCExample/bin/splunk_ta_uccexample_rh_account.py
@@ -57,6 +57,20 @@
         default=None,
         validator=None
     ), 
+    field.RestField(
+        'config1_help_link',
+        required=False,
+        encrypted=False,
+        default=None,
+        validator=None
+    ), 
+    field.RestField(
+        'config2_help_link',
+        required=False,
+        encrypted=False,
+        default=None,
+        validator=None
+    ), 
     field.RestField(
         'username',
         required=False,

diff --git a/tests/testdata/test_addons/package_global_config_everything/globalConfig.json b/tests/testdata/test_addons/package_global_config_everything/globalConfig.json
@@ -189,6 +189,22 @@
                                 "text": "Help Link",
                                 "link": "https://docs.splunk.com/Documentation"
                             }
+                        },
+                        {
+                            "field": "config1_help_link",
+                            "type": "helpLink",
+                            "options": {
+                                "text": "Add-on configuration documentation",
+                                "link": "https://docs.splunk.com/Documentation"
+                            }
+                        },
+                        {
+                            "field": "config2_help_link",
+                            "type": "helpLink",
+                            "options": {
+                                "text": "SSL configuration documentation",
+                                "link": "https://docs.splunk.com/Documentation"
+                            }
                         }
                     ],
                     "title": "Account"
@@ -1302,7 +1318,7 @@
     "meta": {
         "name": "Splunk_TA_UCCExample",
         "restRoot": "splunk_ta_uccexample",
-        "version": "5.31.1Rdd3a1ca0",
+        "version": "5.32.0Rf6551a7f",
         "displayName": "Splunk UCC test Add-on",
         "schemaVersion": "0.0.3"
     }