Add priority field to SDS rule and standard-pattern (#1803)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-12-13 18:04:58.948838",
-            "spec_repo_commit": "493effcf"
+            "regenerated": "2023-12-14 10:49:25.707098",
+            "spec_repo_commit": "43a99a56"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-12-13 18:04:58.963229",
-            "spec_repo_commit": "493effcf"
+            "regenerated": "2023-12-14 10:49:25.793558",
+            "spec_repo_commit": "43a99a56"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -16320,6 +16320,12 @@ components:
         pattern:
           description: Not included if there is a relationship to a standard pattern.
           type: string
+        priority:
+          description: Integer from 1 (high) to 5 (low) indicating rule issue severity.
+          format: int64
+          maximum: 5
+          minimum: 1
+          type: integer
         tags:
           description: List of tags.
           items:
@@ -16475,6 +16481,13 @@ components:
         pattern:
           description: Regex to match.
           type: string
+        priority:
+          description: Integer from 1 (high) to 5 (low) indicating standard pattern
+            issue severity.
+          format: int64
+          maximum: 5
+          minimum: 1
+          type: integer
         tags:
           description: List of tags.
           items:

examples/v2/sensitive-data-scanner/CreateScanningRule.py

@@ -42,6 +42,7 @@
                 "sensitive_data:true",
             ],
             is_enabled=True,
+            priority=1,
         ),
         relationships=SensitiveDataScannerRuleRelationships(
             group=SensitiveDataScannerGroupData(

examples/v2/sensitive-data-scanner/UpdateScanningRule.py

@@ -40,6 +40,7 @@
                 "sensitive_data:true",
             ],
             is_enabled=True,
+            priority=5,
         ),
         relationships=SensitiveDataScannerRuleRelationships(
             group=SensitiveDataScannerGroupData(

src/datadog_api_client/v2/model/sensitive_data_scanner_rule_attributes.py

@@ -18,6 +18,13 @@
 
 
 class SensitiveDataScannerRuleAttributes(ModelNormal):
+    validations = {
+        "priority": {
+            "inclusive_maximum": 5,
+            "inclusive_minimum": 1,
+        },
+    }
+
     @cached_property
     def openapi_types(_):
         from datadog_api_client.v2.model.sensitive_data_scanner_text_replacement import (
@@ -31,6 +38,7 @@ def openapi_types(_):
             "name": (str,),
             "namespaces": ([str],),
             "pattern": (str,),
+            "priority": (int,),
             "tags": ([str],),
             "text_replacement": (SensitiveDataScannerTextReplacement,),
         }
@@ -42,6 +50,7 @@ def openapi_types(_):
         "name": "name",
         "namespaces": "namespaces",
         "pattern": "pattern",
+        "priority": "priority",
         "tags": "tags",
         "text_replacement": "text_replacement",
     }
@@ -54,6 +63,7 @@ def __init__(
         name: Union[str, UnsetType] = unset,
         namespaces: Union[List[str], UnsetType] = unset,
         pattern: Union[str, UnsetType] = unset,
+        priority: Union[int, UnsetType] = unset,
         tags: Union[List[str], UnsetType] = unset,
         text_replacement: Union[SensitiveDataScannerTextReplacement, UnsetType] = unset,
         **kwargs,
@@ -80,6 +90,9 @@ def __init__(
         :param pattern: Not included if there is a relationship to a standard pattern.
         :type pattern: str, optional
 
+        :param priority: Integer from 1 (high) to 5 (low) indicating rule issue severity.
+        :type priority: int, optional
+
         :param tags: List of tags.
         :type tags: [str], optional
 
@@ -98,6 +111,8 @@ def __init__(
             kwargs["namespaces"] = namespaces
         if pattern is not unset:
             kwargs["pattern"] = pattern
+        if priority is not unset:
+            kwargs["priority"] = priority
         if tags is not unset:
             kwargs["tags"] = tags
         if text_replacement is not unset:

src/datadog_api_client/v2/model/sensitive_data_scanner_standard_pattern_attributes.py

@@ -14,13 +14,21 @@
 
 
 class SensitiveDataScannerStandardPatternAttributes(ModelNormal):
+    validations = {
+        "priority": {
+            "inclusive_maximum": 5,
+            "inclusive_minimum": 1,
+        },
+    }
+
     @cached_property
     def openapi_types(_):
         return {
             "description": (str,),
             "included_keywords": ([str],),
             "name": (str,),
             "pattern": (str,),
+            "priority": (int,),
             "tags": ([str],),
         }
 
@@ -29,6 +37,7 @@ def openapi_types(_):
         "included_keywords": "included_keywords",
         "name": "name",
         "pattern": "pattern",
+        "priority": "priority",
         "tags": "tags",
     }
 
@@ -38,6 +47,7 @@ def __init__(
         included_keywords: Union[List[str], UnsetType] = unset,
         name: Union[str, UnsetType] = unset,
         pattern: Union[str, UnsetType] = unset,
+        priority: Union[int, UnsetType] = unset,
         tags: Union[List[str], UnsetType] = unset,
         **kwargs,
     ):
@@ -56,6 +66,9 @@ def __init__(
         :param pattern: Regex to match.
         :type pattern: str, optional
 
+        :param priority: Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.
+        :type priority: int, optional
+
         :param tags: List of tags.
         :type tags: [str], optional
         """
@@ -67,6 +80,8 @@ def __init__(
             kwargs["name"] = name
         if pattern is not unset:
             kwargs["pattern"] = pattern
+        if priority is not unset:
+            kwargs["priority"] = priority
         if tags is not unset:
             kwargs["tags"] = tags
         super().__init__(kwargs)

tests/v2/cassettes/test_scenarios/test_create_scanning_rule_returns_ok_response.frozen

@@ -1 +1 @@
-2023-01-24T13:12:12.388Z
+2023-12-13T09:06:38.820Z

tests/v2/cassettes/test_scenarios/test_create_scanning_rule_returns_ok_response.yaml

@@ -8,7 +8,7 @@ interactions:
     uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config
   response:
     body:
-      string: '{"data":{"id":"7957915c634d4dcb581fa154157f5ad9c2947f50be632fb5599862069f4d2d87","attributes":{},"type":"sensitive_data_scanner_configuration","relationships":{"groups":{"data":[]}}},"meta":{"version":12574,"count_limit":100,"group_count_limit":20,"is_pci_compliant":false,"has_highlight_enabled":true,"has_multi_pass_enabled":true}}
+      string: '{"data":{"id":"7957915c634d4dcb581fa154157f5ad9c2947f50be632fb5599862069f4d2d87","attributes":{},"type":"sensitive_data_scanner_configuration","relationships":{"groups":{"data":[{"id":"z9vY6YO8R-2q6dv_rTUOCA","type":"sensitive_data_scanner_group"},{"id":"01OnORacS5qHeVO7C97drg","type":"sensitive_data_scanner_group"}]}}},"meta":{"version":127243,"count_limit":100,"group_count_limit":20,"is_pci_compliant":false,"has_highlight_enabled":true,"has_multi_pass_enabled":true},"included":[{"id":"z9vY6YO8R-2q6dv_rTUOCA","attributes":{"name":"Example-Update_Scanning_Group_returns_OK_response_1696199477","is_enabled":false,"filter":{"query":"*"},"product_list":["logs"]},"type":"sensitive_data_scanner_group","relationships":{"configuration":{"data":{"id":"7957915c634d4dcb581fa154157f5ad9c2947f50be632fb5599862069f4d2d87","type":"sensitive_data_scanner_configuration"}},"rules":{"data":[]}}},{"id":"01OnORacS5qHeVO7C97drg","attributes":{"name":"my-test-group","is_enabled":false,"filter":{"query":"*"},"product_list":["logs"]},"type":"sensitive_data_scanner_group","relationships":{"configuration":{"data":{"id":"7957915c634d4dcb581fa154157f5ad9c2947f50be632fb5599862069f4d2d87","type":"sensitive_data_scanner_configuration"}},"rules":{"data":[]}}}]}
 
         '
     headers:
@@ -28,7 +28,7 @@ interactions:
     uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/groups
   response:
     body:
-      string: '{"data":{"id":"z7iUhBfcSR6-1kTCPtmdpg","attributes":{"name":"my-test-group","is_enabled":false,"filter":{"query":"*"},"product_list":["logs"]},"type":"sensitive_data_scanner_group","relationships":{"configuration":{"data":{"id":"7957915c634d4dcb581fa154157f5ad9c2947f50be632fb5599862069f4d2d87","type":"sensitive_data_scanner_configuration"}},"rules":{"data":[]}}},"meta":{"version":12575}}
+      string: '{"data":{"id":"Dyurbbz2Tk23SMEr4fcHCw","attributes":{"name":"my-test-group","is_enabled":false,"filter":{"query":"*"},"product_list":["logs"]},"type":"sensitive_data_scanner_group","relationships":{"configuration":{"data":{"id":"7957915c634d4dcb581fa154157f5ad9c2947f50be632fb5599862069f4d2d87","type":"sensitive_data_scanner_configuration"}},"rules":{"data":[]}}},"meta":{"version":127244}}
 
         '
     headers:
@@ -38,7 +38,7 @@ interactions:
       code: 200
       message: OK
 - request:
-    body: '{"data":{"attributes":{"excluded_namespaces":["admin.name"],"is_enabled":true,"name":"Test-Create_Scanning_Rule_returns_OK_response-1674565932","namespaces":["admin"],"pattern":"pattern","tags":["sensitive_data:true"],"text_replacement":{"type":"none"}},"relationships":{"group":{"data":{"id":"z7iUhBfcSR6-1kTCPtmdpg","type":"sensitive_data_scanner_group"}}},"type":"sensitive_data_scanner_rule"},"meta":{}}'
+    body: '{"data":{"attributes":{"excluded_namespaces":["admin.name"],"is_enabled":true,"name":"Test-Create_Scanning_Rule_returns_OK_response-1702458398","namespaces":["admin"],"pattern":"pattern","priority":1,"tags":["sensitive_data:true"],"text_replacement":{"type":"none"}},"relationships":{"group":{"data":{"id":"Dyurbbz2Tk23SMEr4fcHCw","type":"sensitive_data_scanner_group"}}},"type":"sensitive_data_scanner_rule"},"meta":{}}'
     headers:
       accept:
       - application/json
@@ -48,7 +48,7 @@ interactions:
     uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/rules
   response:
     body:
-      string: '{"data":{"id":"r3NAGDIXQcSyNhfFPUZLSg","attributes":{"name":"Test-Create_Scanning_Rule_returns_OK_response-1674565932","namespaces":["admin"],"excluded_namespaces":["admin.name"],"pattern":"pattern","text_replacement":{"type":"none"},"tags":["sensitive_data:true"],"is_enabled":true},"type":"sensitive_data_scanner_rule","relationships":{"group":{"data":{"id":"z7iUhBfcSR6-1kTCPtmdpg","type":"sensitive_data_scanner_group"}}}},"meta":{"version":12576}}
+      string: '{"data":{"id":"Xp3fpaEhSGKqtDFmXvJZwQ","attributes":{"name":"Test-Create_Scanning_Rule_returns_OK_response-1702458398","namespaces":["admin"],"excluded_namespaces":["admin.name"],"pattern":"pattern","text_replacement":{"type":"none"},"tags":["sensitive_data:true"],"is_enabled":true,"priority":1},"type":"sensitive_data_scanner_rule","relationships":{"group":{"data":{"id":"Dyurbbz2Tk23SMEr4fcHCw","type":"sensitive_data_scanner_group"}}}},"meta":{"version":127245}}
 
         '
     headers:
@@ -65,10 +65,10 @@ interactions:
       content-type:
       - application/json
     method: DELETE
-    uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/rules/r3NAGDIXQcSyNhfFPUZLSg
+    uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/rules/Xp3fpaEhSGKqtDFmXvJZwQ
   response:
     body:
-      string: '{"meta":{"version":12577}}
+      string: '{"meta":{"version":127246}}
 
         '
     headers:
@@ -85,10 +85,10 @@ interactions:
       content-type:
       - application/json
     method: DELETE
-    uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/groups/z7iUhBfcSR6-1kTCPtmdpg
+    uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/groups/Dyurbbz2Tk23SMEr4fcHCw
   response:
     body:
-      string: '{"meta":{"version":12578}}
+      string: '{"meta":{"version":127247}}
 
         '
     headers:

tests/v2/cassettes/test_scenarios/test_update_scanning_rule_returns_ok_response.frozen

@@ -1 +1 @@
-2023-01-24T13:12:20.575Z
+2023-12-13T09:06:40.913Z

tests/v2/cassettes/test_scenarios/test_update_scanning_rule_returns_ok_response.yaml

@@ -8,7 +8,7 @@ interactions:
     uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config
   response:
     body:
-      string: '{"data":{"id":"7957915c634d4dcb581fa154157f5ad9c2947f50be632fb5599862069f4d2d87","attributes":{},"type":"sensitive_data_scanner_configuration","relationships":{"groups":{"data":[]}}},"meta":{"version":12586,"count_limit":100,"group_count_limit":20,"is_pci_compliant":false,"has_highlight_enabled":true,"has_multi_pass_enabled":true}}
+      string: '{"data":{"id":"7957915c634d4dcb581fa154157f5ad9c2947f50be632fb5599862069f4d2d87","attributes":{},"type":"sensitive_data_scanner_configuration","relationships":{"groups":{"data":[{"id":"z9vY6YO8R-2q6dv_rTUOCA","type":"sensitive_data_scanner_group"},{"id":"01OnORacS5qHeVO7C97drg","type":"sensitive_data_scanner_group"}]}}},"meta":{"version":127247,"count_limit":100,"group_count_limit":20,"is_pci_compliant":false,"has_highlight_enabled":true,"has_multi_pass_enabled":true},"included":[{"id":"z9vY6YO8R-2q6dv_rTUOCA","attributes":{"name":"Example-Update_Scanning_Group_returns_OK_response_1696199477","is_enabled":false,"filter":{"query":"*"},"product_list":["logs"]},"type":"sensitive_data_scanner_group","relationships":{"configuration":{"data":{"id":"7957915c634d4dcb581fa154157f5ad9c2947f50be632fb5599862069f4d2d87","type":"sensitive_data_scanner_configuration"}},"rules":{"data":[]}}},{"id":"01OnORacS5qHeVO7C97drg","attributes":{"name":"my-test-group","is_enabled":false,"filter":{"query":"*"},"product_list":["logs"]},"type":"sensitive_data_scanner_group","relationships":{"configuration":{"data":{"id":"7957915c634d4dcb581fa154157f5ad9c2947f50be632fb5599862069f4d2d87","type":"sensitive_data_scanner_configuration"}},"rules":{"data":[]}}}]}
 
         '
     headers:
@@ -28,7 +28,7 @@ interactions:
     uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/groups
   response:
     body:
-      string: '{"data":{"id":"g0hUfjkqQEejgzkTN8J1sA","attributes":{"name":"my-test-group","is_enabled":false,"filter":{"query":"*"},"product_list":["logs"]},"type":"sensitive_data_scanner_group","relationships":{"configuration":{"data":{"id":"7957915c634d4dcb581fa154157f5ad9c2947f50be632fb5599862069f4d2d87","type":"sensitive_data_scanner_configuration"}},"rules":{"data":[]}}},"meta":{"version":12587}}
+      string: '{"data":{"id":"LAf2eSOlTQ6RTz2rwiQGsA","attributes":{"name":"my-test-group","is_enabled":false,"filter":{"query":"*"},"product_list":["logs"]},"type":"sensitive_data_scanner_group","relationships":{"configuration":{"data":{"id":"7957915c634d4dcb581fa154157f5ad9c2947f50be632fb5599862069f4d2d87","type":"sensitive_data_scanner_configuration"}},"rules":{"data":[]}}},"meta":{"version":127248}}
 
         '
     headers:
@@ -38,7 +38,7 @@ interactions:
       code: 200
       message: OK
 - request:
-    body: '{"data":{"attributes":{"is_enabled":true,"name":"Test-Update_Scanning_Rule_returns_OK_response-1674565940","namespaces":["admin.email"],"pattern":"pattern","tags":["sensitive_data:true"],"text_replacement":{"type":"none"}},"relationships":{"group":{"data":{"id":"g0hUfjkqQEejgzkTN8J1sA","type":"sensitive_data_scanner_group"}}},"type":"sensitive_data_scanner_rule"},"meta":{}}'
+    body: '{"data":{"attributes":{"is_enabled":true,"name":"Test-Update_Scanning_Rule_returns_OK_response-1702458400","namespaces":["admin.email"],"pattern":"pattern","tags":["sensitive_data:true"],"text_replacement":{"type":"none"}},"relationships":{"group":{"data":{"id":"LAf2eSOlTQ6RTz2rwiQGsA","type":"sensitive_data_scanner_group"}}},"type":"sensitive_data_scanner_rule"},"meta":{}}'
     headers:
       accept:
       - application/json
@@ -48,7 +48,7 @@ interactions:
     uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/rules
   response:
     body:
-      string: '{"data":{"id":"miOWlXzWQXCJaJktLUW40g","attributes":{"name":"Test-Update_Scanning_Rule_returns_OK_response-1674565940","namespaces":["admin.email"],"excluded_namespaces":[],"pattern":"pattern","text_replacement":{"type":"none"},"tags":["sensitive_data:true"],"is_enabled":true},"type":"sensitive_data_scanner_rule","relationships":{"group":{"data":{"id":"g0hUfjkqQEejgzkTN8J1sA","type":"sensitive_data_scanner_group"}}}},"meta":{"version":12588}}
+      string: '{"data":{"id":"N7Hb8CgTRayW0VADXfo9Wg","attributes":{"name":"Test-Update_Scanning_Rule_returns_OK_response-1702458400","namespaces":["admin.email"],"excluded_namespaces":[],"pattern":"pattern","text_replacement":{"type":"none"},"tags":["sensitive_data:true"],"is_enabled":true},"type":"sensitive_data_scanner_rule","relationships":{"group":{"data":{"id":"LAf2eSOlTQ6RTz2rwiQGsA","type":"sensitive_data_scanner_group"}}}},"meta":{"version":127249}}
 
         '
     headers:
@@ -58,17 +58,17 @@ interactions:
       code: 200
       message: OK
 - request:
-    body: '{"data":{"attributes":{"is_enabled":true,"name":"Test-Update_Scanning_Rule_returns_OK_response-1674565940","pattern":"pattern","tags":["sensitive_data:true"],"text_replacement":{"type":"none"}},"id":"miOWlXzWQXCJaJktLUW40g","relationships":{"group":{"data":{"id":"g0hUfjkqQEejgzkTN8J1sA","type":"sensitive_data_scanner_group"}}},"type":"sensitive_data_scanner_rule"},"meta":{}}'
+    body: '{"data":{"attributes":{"is_enabled":true,"name":"Test-Update_Scanning_Rule_returns_OK_response-1702458400","pattern":"pattern","priority":5,"tags":["sensitive_data:true"],"text_replacement":{"type":"none"}},"id":"N7Hb8CgTRayW0VADXfo9Wg","relationships":{"group":{"data":{"id":"LAf2eSOlTQ6RTz2rwiQGsA","type":"sensitive_data_scanner_group"}}},"type":"sensitive_data_scanner_rule"},"meta":{}}'
     headers:
       accept:
       - application/json
       content-type:
       - application/json
     method: PATCH
-    uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/rules/miOWlXzWQXCJaJktLUW40g
+    uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/rules/N7Hb8CgTRayW0VADXfo9Wg
   response:
     body:
-      string: '{"meta":{"version":12589}}
+      string: '{"meta":{"version":127250}}
 
         '
     headers:
@@ -85,10 +85,10 @@ interactions:
       content-type:
       - application/json
     method: DELETE
-    uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/rules/miOWlXzWQXCJaJktLUW40g
+    uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/rules/N7Hb8CgTRayW0VADXfo9Wg
   response:
     body:
-      string: '{"meta":{"version":12590}}
+      string: '{"meta":{"version":127251}}
 
         '
     headers:
@@ -105,10 +105,10 @@ interactions:
       content-type:
       - application/json
     method: DELETE
-    uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/groups/g0hUfjkqQEejgzkTN8J1sA
+    uri: https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/groups/LAf2eSOlTQ6RTz2rwiQGsA
   response:
     body:
-      string: '{"meta":{"version":12591}}
+      string: '{"meta":{"version":127252}}
 
         '
     headers: