[K9VULN-4477]: Remove Description and Icon URL as Required Fields From Get Framework (#2562)

Co-authored-by: ci.datadog-api-spec <[email protected]>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-13 09:46:36.398294",
-            "spec_repo_commit": "767fe63b"
+            "regenerated": "2025-05-13 17:47:38.627635",
+            "spec_repo_commit": "b673a489"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-13 09:46:36.413318",
-            "spec_repo_commit": "767fe63b"
+            "regenerated": "2025-05-13 17:47:38.642768",
+            "spec_repo_commit": "b673a489"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -10937,8 +10937,6 @@ components:
       - handle
       - version
       - name
-      - description
-      - icon_url
       type: object
     DORADeploymentRequest:
       description: Request to create a DORA deployment event.
@@ -15262,10 +15260,6 @@ components:
     FullCustomFrameworkDataAttributes:
       description: Full Framework Data Attributes.
       properties:
-        description:
-          description: Framework Description
-          example: this is a security framework
-          type: string
         handle:
           description: Framework Handle
           example: sec2
@@ -15291,8 +15285,6 @@ components:
       - handle
       - version
       - name
-      - description
-      - icon_url
       - requirements
       type: object
     GCPMetricNamespaceConfig:

src/datadog_api_client/v2/model/custom_framework_without_requirements.py

@@ -3,10 +3,13 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
+from typing import Union
 
 from datadog_api_client.model_utils import (
     ModelNormal,
     cached_property,
+    unset,
+    UnsetType,
 )
 
 
@@ -29,29 +32,39 @@ def openapi_types(_):
         "version": "version",
     }
 
-    def __init__(self_, description: str, handle: str, icon_url: str, name: str, version: str, **kwargs):
+    def __init__(
+        self_,
+        handle: str,
+        name: str,
+        version: str,
+        description: Union[str, UnsetType] = unset,
+        icon_url: Union[str, UnsetType] = unset,
+        **kwargs,
+    ):
         """
         Framework without requirements.
 
         :param description: Framework Description
-        :type description: str
+        :type description: str, optional
 
         :param handle: Framework Handle
         :type handle: str
 
         :param icon_url: Framework Icon URL
-        :type icon_url: str
+        :type icon_url: str, optional
 
         :param name: Framework Name
         :type name: str
 
         :param version: Framework Version
         :type version: str
         """
+        if description is not unset:
+            kwargs["description"] = description
+        if icon_url is not unset:
+            kwargs["icon_url"] = icon_url
         super().__init__(kwargs)
 
-        self_.description = description
         self_.handle = handle
-        self_.icon_url = icon_url
         self_.name = name
         self_.version = version

src/datadog_api_client/v2/model/full_custom_framework_data_attributes.py

@@ -3,11 +3,13 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
-from typing import List, TYPE_CHECKING
+from typing import List, Union, TYPE_CHECKING
 
 from datadog_api_client.model_utils import (
     ModelNormal,
     cached_property,
+    unset,
+    UnsetType,
 )
 
 
@@ -21,7 +23,6 @@ def openapi_types(_):
         from datadog_api_client.v2.model.custom_framework_requirement import CustomFrameworkRequirement
 
         return {
-            "description": (str,),
             "handle": (str,),
             "icon_url": (str,),
             "name": (str,),
@@ -30,7 +31,6 @@ def openapi_types(_):
         }
 
     attribute_map = {
-        "description": "description",
         "handle": "handle",
         "icon_url": "icon_url",
         "name": "name",
@@ -40,25 +40,21 @@ def openapi_types(_):
 
     def __init__(
         self_,
-        description: str,
         handle: str,
-        icon_url: str,
         name: str,
         requirements: List[CustomFrameworkRequirement],
         version: str,
+        icon_url: Union[str, UnsetType] = unset,
         **kwargs,
     ):
         """
         Full Framework Data Attributes.
 
-        :param description: Framework Description
-        :type description: str
-
         :param handle: Framework Handle
         :type handle: str
 
         :param icon_url: Framework Icon URL
-        :type icon_url: str
+        :type icon_url: str, optional
 
         :param name: Framework Name
         :type name: str
@@ -69,11 +65,11 @@ def __init__(
         :param version: Framework Version
         :type version: str
         """
+        if icon_url is not unset:
+            kwargs["icon_url"] = icon_url
         super().__init__(kwargs)
 
-        self_.description = description
         self_.handle = handle
-        self_.icon_url = icon_url
         self_.name = name
         self_.requirements = requirements
         self_.version = version

tests/v2/cassettes/test_scenarios/test_get_a_custom_framework_returns_ok_response.frozen

@@ -1 +1 @@
-2025-04-27T22:14:16.448Z
+2025-05-13T17:29:58.139Z

tests/v2/cassettes/test_scenarios/test_get_a_custom_framework_returns_ok_response.yaml

@@ -26,7 +26,7 @@ interactions:
     uri: https://api.datadoghq.com/api/v2/cloud_security_management/custom_frameworks/create-framework-new/10
   response:
     body:
-      string: '{"data":{"id":"create-framework-new-10","type":"custom_framework","attributes":{"description":"","handle":"create-framework-new","icon_url":"test-url","name":"name","requirements":[{"name":"requirement","controls":[{"name":"control","rules_id":["def-000-be9"]}]}],"version":"10"}}}'
+      string: '{"data":{"id":"create-framework-new-10","type":"custom_framework","attributes":{"handle":"create-framework-new","icon_url":"test-url","name":"name","requirements":[{"name":"requirement","controls":[{"name":"control","rules_id":["def-000-be9"]}]}],"version":"10"}}}'
     headers:
       content-type:
       - application/vnd.api+json