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

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit eb78ef4391cc · 2025-05-13T19:30:29.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-13 09:46:04.726154",
-            "spec_repo_commit": "767fe63b"
+            "regenerated": "2025-05-13 17:47:36.777678",
+            "spec_repo_commit": "b673a489"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-13 09:46:04.743250",
-            "spec_repo_commit": "767fe63b"
+            "regenerated": "2025-05-13 17:47:36.793298",
+            "spec_repo_commit": "b673a489"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.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:
diff --git a/src/datadogV2/model/model_custom_framework_without_requirements.rs b/src/datadogV2/model/model_custom_framework_without_requirements.rs
@@ -13,13 +13,13 @@ use std::fmt::{self, Formatter};
 pub struct CustomFrameworkWithoutRequirements {
     /// Framework Description
     #[serde(rename = "description")]
-    pub description: String,
+    pub description: Option<String>,
     /// Framework Handle
     #[serde(rename = "handle")]
     pub handle: String,
     /// Framework Icon URL
     #[serde(rename = "icon_url")]
-    pub icon_url: String,
+    pub icon_url: Option<String>,
     /// Framework Name
     #[serde(rename = "name")]
     pub name: String,
@@ -35,23 +35,31 @@ pub struct CustomFrameworkWithoutRequirements {
 
 impl CustomFrameworkWithoutRequirements {
     pub fn new(
-        description: String,
         handle: String,
-        icon_url: String,
         name: String,
         version: String,
     ) -> CustomFrameworkWithoutRequirements {
         CustomFrameworkWithoutRequirements {
-            description,
+            description: None,
             handle,
-            icon_url,
+            icon_url: None,
             name,
             version,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
         }
     }
 
+    pub fn description(mut self, value: String) -> Self {
+        self.description = Some(value);
+        self
+    }
+
+    pub fn icon_url(mut self, value: String) -> Self {
+        self.icon_url = Some(value);
+        self
+    }
+
     pub fn additional_properties(
         mut self,
         value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -92,13 +100,19 @@ impl<'de> Deserialize<'de> for CustomFrameworkWithoutRequirements {
                 while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
                     match k.as_str() {
                         "description" => {
+                            if v.is_null() {
+                                continue;
+                            }
                             description =
                                 Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
                         "handle" => {
                             handle = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
                         "icon_url" => {
+                            if v.is_null() {
+                                continue;
+                            }
                             icon_url = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
                         "name" => {
@@ -114,10 +128,7 @@ impl<'de> Deserialize<'de> for CustomFrameworkWithoutRequirements {
                         }
                     }
                 }
-                let description =
-                    description.ok_or_else(|| M::Error::missing_field("description"))?;
                 let handle = handle.ok_or_else(|| M::Error::missing_field("handle"))?;
-                let icon_url = icon_url.ok_or_else(|| M::Error::missing_field("icon_url"))?;
                 let name = name.ok_or_else(|| M::Error::missing_field("name"))?;
                 let version = version.ok_or_else(|| M::Error::missing_field("version"))?;
 
diff --git a/src/datadogV2/model/model_full_custom_framework_data_attributes.rs b/src/datadogV2/model/model_full_custom_framework_data_attributes.rs
@@ -11,15 +11,12 @@ use std::fmt::{self, Formatter};
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct FullCustomFrameworkDataAttributes {
-    /// Framework Description
-    #[serde(rename = "description")]
-    pub description: String,
     /// Framework Handle
     #[serde(rename = "handle")]
     pub handle: String,
     /// Framework Icon URL
     #[serde(rename = "icon_url")]
-    pub icon_url: String,
+    pub icon_url: Option<String>,
     /// Framework Name
     #[serde(rename = "name")]
     pub name: String,
@@ -38,17 +35,14 @@ pub struct FullCustomFrameworkDataAttributes {
 
 impl FullCustomFrameworkDataAttributes {
     pub fn new(
-        description: String,
         handle: String,
-        icon_url: String,
         name: String,
         requirements: Vec<crate::datadogV2::model::CustomFrameworkRequirement>,
         version: String,
     ) -> FullCustomFrameworkDataAttributes {
         FullCustomFrameworkDataAttributes {
-            description,
             handle,
-            icon_url,
+            icon_url: None,
             name,
             requirements,
             version,
@@ -57,6 +51,11 @@ impl FullCustomFrameworkDataAttributes {
         }
     }
 
+    pub fn icon_url(mut self, value: String) -> Self {
+        self.icon_url = Some(value);
+        self
+    }
+
     pub fn additional_properties(
         mut self,
         value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -83,7 +82,6 @@ impl<'de> Deserialize<'de> for FullCustomFrameworkDataAttributes {
             where
                 M: MapAccess<'a>,
             {
-                let mut description: Option<String> = None;
                 let mut handle: Option<String> = None;
                 let mut icon_url: Option<String> = None;
                 let mut name: Option<String> = None;
@@ -99,14 +97,13 @@ impl<'de> Deserialize<'de> for FullCustomFrameworkDataAttributes {
 
                 while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
                     match k.as_str() {
-                        "description" => {
-                            description =
-                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
-                        }
                         "handle" => {
                             handle = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
                         "icon_url" => {
+                            if v.is_null() {
+                                continue;
+                            }
                             icon_url = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
                         "name" => {
@@ -126,17 +123,13 @@ impl<'de> Deserialize<'de> for FullCustomFrameworkDataAttributes {
                         }
                     }
                 }
-                let description =
-                    description.ok_or_else(|| M::Error::missing_field("description"))?;
                 let handle = handle.ok_or_else(|| M::Error::missing_field("handle"))?;
-                let icon_url = icon_url.ok_or_else(|| M::Error::missing_field("icon_url"))?;
                 let name = name.ok_or_else(|| M::Error::missing_field("name"))?;
                 let requirements =
                     requirements.ok_or_else(|| M::Error::missing_field("requirements"))?;
                 let version = version.ok_or_else(|| M::Error::missing_field("version"))?;
 
                 let content = FullCustomFrameworkDataAttributes {
-                    description,
                     handle,
                     icon_url,
                     name,
diff --git a/tests/scenarios/cassettes/v2/security_monitoring/Get-a-custom-framework-returns-OK-response.frozen b/tests/scenarios/cassettes/v2/security_monitoring/Get-a-custom-framework-returns-OK-response.frozen
@@ -1 +1 @@
-2025-04-27T22:14:16.448Z
+2025-05-13T17:29:58.139Z
diff --git a/tests/scenarios/cassettes/v2/security_monitoring/Get-a-custom-framework-returns-OK-response.json b/tests/scenarios/cassettes/v2/security_monitoring/Get-a-custom-framework-returns-OK-response.json
@@ -32,7 +32,7 @@
           "message": "OK"
         }
       },
-      "recorded_at": "Sun, 27 Apr 2025 22:14:16 GMT"
+      "recorded_at": "Tue, 13 May 2025 17:29:58 GMT"
     },
     {
       "request": {
@@ -47,7 +47,7 @@
       },
       "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\"}}}",
           "encoding": null
         },
         "headers": {
@@ -60,7 +60,7 @@
           "message": "OK"
         }
       },
-      "recorded_at": "Sun, 27 Apr 2025 22:14:16 GMT"
+      "recorded_at": "Tue, 13 May 2025 17:29:58 GMT"
     },
     {
       "request": {
@@ -88,7 +88,7 @@
           "message": "OK"
         }
       },
-      "recorded_at": "Sun, 27 Apr 2025 22:14:16 GMT"
+      "recorded_at": "Tue, 13 May 2025 17:29:58 GMT"
     }
   ],
   "recorded_with": "VCR 6.0.0"

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.6",`
`7`		`- "regenerated": "2025-05-13 09:46:04.726154",`
`8`		`- "spec_repo_commit": "767fe63b"`
	`7`	`+ "regenerated": "2025-05-13 17:47:36.777678",`
	`8`	`+ "spec_repo_commit": "b673a489"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2025-05-13 09:46:04.743250",`
`13`		`- "spec_repo_commit": "767fe63b"`
	`12`	`+ "regenerated": "2025-05-13 17:47:36.793298",`
	`13`	`+ "spec_repo_commit": "b673a489"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-2025-04-27T22:14:16.448Z`
	`1`	`+2025-05-13T17:29:58.139Z`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@`
`32`	`32`	`"message": "OK"`
`33`	`33`	`}`
`34`	`34`	`},`
`35`		`- "recorded_at": "Sun, 27 Apr 2025 22:14:16 GMT"`
	`35`	`+ "recorded_at": "Tue, 13 May 2025 17:29:58 GMT"`
`36`	`36`	`},`
`37`	`37`	`{`
`38`	`38`	`"request": {`
`@@ -47,7 +47,7 @@`
`47`	`47`	`},`
`48`	`48`	`"response": {`
`49`	`49`	`"body": {`
`50`		`- "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\"}}}",`
	`50`	`+ "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\"}}}",`
`51`	`51`	`"encoding": null`
`52`	`52`	`},`
`53`	`53`	`"headers": {`
`@@ -60,7 +60,7 @@`
`60`	`60`	`"message": "OK"`
`61`	`61`	`}`
`62`	`62`	`},`
`63`		`- "recorded_at": "Sun, 27 Apr 2025 22:14:16 GMT"`
	`63`	`+ "recorded_at": "Tue, 13 May 2025 17:29:58 GMT"`
`64`	`64`	`},`
`65`	`65`	`{`
`66`	`66`	`"request": {`
`@@ -88,7 +88,7 @@`
`88`	`88`	`"message": "OK"`
`89`	`89`	`}`
`90`	`90`	`},`
`91`		`- "recorded_at": "Sun, 27 Apr 2025 22:14:16 GMT"`
	`91`	`+ "recorded_at": "Tue, 13 May 2025 17:29:58 GMT"`
`92`	`92`	`}`
`93`	`93`	`],`
`94`	`94`	`"recorded_with": "VCR 6.0.0"`