Align content to id and name

.changelog/5160.yml

@@ -0,0 +1,4 @@
+changes:
+- description: Updated the content item structure to adopt standardized id and name fields.
+  type: internal
+pr_number: 5160

TestSuite/layout_rule.py

@@ -21,7 +21,9 @@ def __init__(
     def create_default_layout_rule(self):
         self.write_json(
             {
+                "id": self.rule_id,
                 "rule_id": self.rule_id,
+                "name": self.name,
                 "rule_name": self.name,
                 "layout_id": "test_layout",
                 "description": "",

TestSuite/trigger.py

@@ -18,11 +18,11 @@ def __init__(self, name: str, trigger_dir_path: Path, json_content: dict = None)
     def create_default_trigger(self):
         self.write_json(
             {
-                "trigger_id": self.id,
+                "id": self.id,
+                "name": self.id,
                 "playbook_id": "mock playbook",
                 "suggestion_reason": "mock reason",
                 "description": "desc",
-                "trigger_name": self.id,
                 "alerts_filter": {
                     "filter": {
                         "AND": [

TestSuite/xdrc_template.py

@@ -32,7 +32,7 @@ def write_dict(self, yml: dict):
     def create_default(self):
         self.write_json(
             {
-                "content_global_id": self.id,
+                "id": self.id,
                 "name": self.id,
                 "os_type": "os_type_test",
                 "profile_type": "profile_type_test",

TestSuite/xsiam_dashboard.py

@@ -17,6 +17,7 @@ def create_default(self):
             {
                 "dashboards_data": [
                     {
+                        "id": self.id,
                         "name": self.id,
                         "description": "mock dashboard desc",
                         "status": "ENABLED",

TestSuite/xsiam_report.py

@@ -17,8 +17,8 @@ def create_default(self):
             {
                 "templates_data": [
                     {
-                        "global_id": self.id,
-                        "report_name": self.id,
+                        "id": self.id,
+                        "name": self.id,
                         "report_description": None,
                         "default_template_id": None,
                         "time_frame": {"relativeTime": 86400000},

demisto_sdk/commands/common/schemas/layoutrule.yml

@@ -1,11 +1,19 @@
 type: map
 mapping:
+  id:
+    type: str
+    required: true
   rule_id:
+    type: str
+    required: false
+    # DEPRECATED: Use 'id' field instead. This field is kept for backward compatibility with existing content items.
+  name:
     type: str
     required: true
   rule_name:
     type: str
-    required: true
+    required: false
+    # DEPRECATED: Use 'name' field instead. This field is kept for backward compatibility with existing content items.
   layout_id:
     type: str
     required: true

demisto_sdk/commands/common/schemas/trigger.yml

@@ -4,16 +4,24 @@ mapping:
     type: str
   automation_id:
     type: str
-  trigger_id:
+  id:
     type: str
     required: true
+  trigger_id:
+    type: str
+    required: false
+    # DEPRECATED: Use 'id' field instead. This field is kept for backward compatibility with existing content items.
   fromVersion:
     type: str
   toVersion:
     type: str
-  trigger_name:
+  name:
     type: str
     required: true
+  trigger_name:
+    type: str
+    required: false
+    # DEPRECATED: Use 'name' field instead. This field is kept for backward compatibility with existing content items.
   playbook_id:
     type: str
   description:

demisto_sdk/commands/common/schemas/xdrctemplate.yml

@@ -9,9 +9,13 @@ mapping:
   name:
     type: str
     required: true
-  content_global_id:
+  id:
     type: str
     required: true
+  content_global_id:
+    type: str
+    required: false
+    # DEPRECATED: Use 'id' field instead. This field is kept for backward compatibility with existing content items.
   from_xdr_version:
     type: str
     required: true

demisto_sdk/commands/common/schemas/xsiamdashboard.yml

@@ -27,9 +27,13 @@ mapping:
 schema;dashboards_data_schema:
   type: map
   mapping:
-    global_id:
+    id:
       type: str
       required: true
+    global_id:
+      type: str
+      required: false
+      # DEPRECATED: Use 'id' field instead. This field is kept for backward compatibility with existing content items.
     status:
       type: str
       required: true

demisto_sdk/commands/common/schemas/xsiamreport.yml

@@ -19,12 +19,20 @@ schema;templates_data_schema:
   mapping:
     metadata:
       type: str
+    id:
+      type: str
+      required: true
     global_id:
+      type: str
+      required: false
+      # DEPRECATED: Use 'id' field instead. This field is kept for backward compatibility with existing content items.
+    name:
       type: str
       required: true
     report_name:
       type: str
-      required: true
+      required: false
+      # DEPRECATED: Use 'name' field instead. This field is kept for backward compatibility with existing content items.
     report_description:
       type: str
       required: false

demisto_sdk/commands/common/tests/layout_rule_test.py

@@ -14,10 +14,10 @@ def test_is_valid_file(repo):
     dummy_layout_rule = pack.create_layout_rule(
         "MyRule",
         {
-            "rule_id": "test_rule",
+            "id": "test_rule",
             "layout_id": "test_layout_id",
             "description": "This trigger is test",
-            "rule_name": "test rule name",
+            "name": "test rule name",
             "alerts_filter": {
                 "filter": {
                     "AND": [
@@ -50,10 +50,10 @@ def test_is_valid_file_complicated_schema(repo):
     dummy_layout_rule = pack.create_layout_rule(
         "MyRule",
         {
-            "rule_id": "test_rule",
+            "id": "test_rule",
             "layout_id": "test_layout_id",
             "description": "This trigger is test",
-            "rule_name": "test rule name",
+            "name": "test rule name",
             "alerts_filter": {
                 "filter": {
                     "OR": [
@@ -109,10 +109,10 @@ def test_is_not_valid_file_complicated_schema(repo):
     dummy_layout_rule = pack.create_layout_rule(
         "MyRule",
         {
-            "rule_id": "test_rule",
+            "id": "test_rule",
             "layout_id": "test_layout_id",
             "description": "This trigger is test",
-            "rule_name": "test rule name",
+            "name": "test rule name",
             "alerts_filter": {
                 "filter": {
                     "OR": [

demisto_sdk/commands/common/tests/structure_test.py

@@ -945,17 +945,17 @@ def test_valid_xsiam_report(self, pack: Pack):
         validator = StructureValidator(xsiam_report.path)
         assert validator.is_valid_scheme()
 
-    def test_invalid_xsiam_report_missing_global_id(self, pack: Pack):
+    def test_invalid_xsiam_report_missing_id(self, pack: Pack):
         """
         Given:
-            An invalid XSIAM report with a missing global_id field
+            An invalid XSIAM report with a missing id field
         When:
             Running schema validation.
         Then:
             Make sure the schema is invalid.
         """
         xsiam_report = pack.create_xsiam_report("xsiam_report")
-        xsiam_report.remove_field_by_path("templates_data.[0].global_id")
+        xsiam_report.remove_field_by_path("templates_data.[0].id")
         validator = StructureValidator(xsiam_report.path)
         assert not validator.is_valid_scheme()
 

demisto_sdk/commands/common/tests/trigger_test.py

@@ -13,11 +13,11 @@ def test_is_valid_file(repo):
     dummy_trigger = pack.create_trigger(
         "MyTrigger",
         {
-            "trigger_id": "trigger_id",
+            "id": "trigger_id",
             "playbook_id": "playbook_id",
             "suggestion_reason": "Reason",
             "description": "Description",
-            "trigger_name": "trigger_name",
+            "name": "trigger_name",
             "alerts_filter": {
                 "filter": {
                     "AND": [
@@ -48,11 +48,11 @@ def test_is_valid_file_complicated_schema(repo):
     dummy_trigger = pack.create_trigger(
         "MyTrigger",
         {
-            "trigger_id": "trigger_id",
+            "id": "trigger_id",
             "playbook_id": "playbook_id",
             "suggestion_reason": "Reason",
             "description": "Description",
-            "trigger_name": "trigger_name",
+            "name": "trigger_name",
             "alerts_filter": {
                 "filter": {
                     "OR": [
@@ -106,11 +106,11 @@ def test_is_not_valid_file_complicated_schema(repo):
     dummy_trigger = pack.create_trigger(
         "MyTrigger",
         {
-            "trigger_id": "trigger_id",
+            "id": "trigger_id",
             "playbook_id": "playbook_id",
             "suggestion_reason": "Reason",
             "description": "Description",
-            "trigger_name": "trigger_name",
+            "name": "trigger_name",
             "alerts_filter": {
                 "filter": {
                     "OR": [

demisto_sdk/commands/content_graph/strict_objects/layout_rule.py

@@ -14,8 +14,10 @@
 
 
 class _StrictLayoutRule(BaseStrictModel):
-    rule_id: str
-    rule_name: str
+    rule_id: Optional[str] = None
+    id: str
+    rule_name: Optional[str] = None
+    name: str
     layout_id: str
     from_version: str = Field(
         alias="fromVersion"

demisto_sdk/commands/content_graph/strict_objects/trigger.py

@@ -14,8 +14,10 @@
 
 
 class _StrictTrigger(BaseStrictModel):
-    trigger_id: str
-    trigger_name: str
+    trigger_id: Optional[str] = None
+    id: str
+    trigger_name: Optional[str] = None
+    name: str
     playbook_id: Optional[str]
     description: str
     suggestion_reason: str

demisto_sdk/commands/content_graph/strict_objects/xdrc_template.py

@@ -16,7 +16,8 @@ class _StrictXDRCTemplate(BaseStrictModel):
     os_type: str
     profile_type: str
     name: str
-    content_global_id: str
+    content_global_id: Optional[str] = None
+    id: str
     from_xdr_version: str
     yaml_template: str
     supportedModules: Optional[List[str]] = Field(None, alias="supportedModules")

demisto_sdk/commands/content_graph/strict_objects/xsiam_dashboard.py

@@ -34,7 +34,8 @@ class _Layout(BaseStrictModel):
 
 
 class _DashboardsData(BaseStrictModel):
-    global_id: str
+    global_id: Optional[str] = None
+    id: str
     status: str
     name: str
     description: Optional[str] = None

demisto_sdk/commands/content_graph/strict_objects/xsiam_report.py

@@ -38,8 +38,10 @@ class TimeFrame(BaseStrictModel):
 
 class TemplatesData(BaseStrictModel):
     metadata: Optional[str] = None
-    global_id: str
-    report_name: str
+    global_id: Optional[str] = None
+    id: str
+    report_name: Optional[str] = None
+    name: str
     report_description: Optional[str] = None
     default_template_id: Optional[int] = None
     time_frame: Optional[TimeFrame] = None