Vbarth/update custom framework

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-14 15:59:04.025656",
-            "spec_repo_commit": "0457044b"
+            "regenerated": "2025-01-14 20:10:50.478546",
+            "spec_repo_commit": "89d2bdc8"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-14 15:59:04.041492",
-            "spec_repo_commit": "0457044b"
+            "regenerated": "2025-01-14 20:10:50.494181",
+            "spec_repo_commit": "89d2bdc8"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -297,6 +297,20 @@ components:
       required: false
       schema:
         $ref: '#/components/schemas/RelationType'
+    FrameworkHandle:
+      description: The framework handle
+      in: path
+      name: handle
+      required: true
+      schema:
+        type: string
+    FrameworkVersion:
+      description: The framework version
+      in: path
+      name: version
+      required: true
+      schema:
+        type: string
     GCPSTSServiceAccountID:
       description: Your GCP STS enabled service account's unique ID.
       in: path
@@ -7145,6 +7159,10 @@ components:
       type: string
       x-enum-varnames:
       - APPDEFINITIONS
+    CreateCustomFrameworkRequest:
+      $ref: '#/components/schemas/FrameworkData'
+      description: Create a custom framework.
+      type: object
     CreateDataDeletionRequestBody:
       description: Object needed to create a data deletion request.
       properties:
@@ -11936,6 +11954,72 @@ components:
         order:
           $ref: '#/components/schemas/QuerySortOrder'
       type: object
+    FrameworkControl:
+      description: Framework Control.
+      properties:
+        name:
+          description: Control Name.
+          example: ''
+          type: string
+        rule_ids:
+          description: Rule IDs.
+          example:
+          - ''
+          items:
+            type: string
+          type: array
+      required:
+      - name
+      - rule_ids
+      type: object
+    FrameworkData:
+      description: Framework Data.
+      properties:
+        description:
+          description: Framework Description
+          type: string
+        handle:
+          description: Framework Handle
+          example: ''
+          type: string
+        icon_url:
+          description: Framework Icon URL
+          type: string
+        name:
+          description: Framework Name
+          example: ''
+          type: string
+        requirements:
+          description: Framework Requirements
+          items:
+            $ref: '#/components/schemas/FrameworkRequirement'
+          type: array
+        version:
+          description: Framework Version
+          example: ''
+          type: string
+      required:
+      - handle
+      - version
+      - name
+      - requirements
+      type: object
+    FrameworkRequirement:
+      description: Framework Requirement.
+      properties:
+        controls:
+          description: Requirement Controls.
+          items:
+            $ref: '#/components/schemas/FrameworkControl'
+          type: array
+        name:
+          description: Requirement Name.
+          example: ''
+          type: string
+      required:
+      - name
+      - controls
+      type: object
     FullAPIKey:
       description: Datadog API key.
       properties:
@@ -28953,6 +29037,10 @@ components:
         deployment:
           $ref: '#/components/schemas/DeploymentRelationship'
       type: object
+    UpdateCustomFrameworkRequest:
+      $ref: '#/components/schemas/FrameworkData'
+      description: Update a custom framework.
+      type: object
     UpdateOpenAPIResponse:
       description: Response for `UpdateOpenAPI`.
       properties:
@@ -33028,6 +33116,77 @@ paths:
         operator: OR
         permissions:
         - ci_visibility_read
+  /api/v2/cloud_security_management/custom_frameworks:
+    post:
+      description: Create a custom framework.
+      operationId: CreateCustomFramework
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateCustomFrameworkRequest'
+        required: true
+      responses:
+        '200':
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+        '500':
+          $ref: '#/components/responses/BadRequestResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - security_monitoring_rules_read
+        - security_monitoring_rules_write
+      summary: Create a custom framework
+      tags:
+      - Security Monitoring
+      x-codegen-request-body-name: body
+      x-permission:
+        operator: AND
+        permissions:
+        - security_monitoring_rules_read
+        - security_monitoring_rules_write
+  /api/v2/cloud_security_management/custom_frameworks/{handle}/{version}:
+    put:
+      description: Update a custom framework.
+      operationId: UpdateCustomFramework
+      parameters:
+      - $ref: '#/components/parameters/FrameworkHandle'
+      - $ref: '#/components/parameters/FrameworkVersion'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdateCustomFrameworkRequest'
+        required: true
+      responses:
+        '200':
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+        '500':
+          $ref: '#/components/responses/BadRequestResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - security_monitoring_rules_read
+        - security_monitoring_rules_write
+      summary: Update a custom framework
+      tags:
+      - Security Monitoring
+      x-codegen-request-body-name: body
+      x-permission:
+        operator: AND
+        permissions:
+        - security_monitoring_rules_read
+        - security_monitoring_rules_write
   /api/v2/container_images:
     get:
       description: Get all Container Images for your organization.

examples/v2/security-monitoring/CreateCustomFramework.rb

@@ -0,0 +1,24 @@
+# Create a custom framework returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+body = DatadogAPIClient::V2::CreateCustomFrameworkRequest.new({
+  handle: "",
+  name: "",
+  requirements: [
+    DatadogAPIClient::V2::FrameworkRequirement.new({
+      controls: [
+        DatadogAPIClient::V2::FrameworkControl.new({
+          name: "",
+          rule_ids: [
+            "",
+          ],
+        }),
+      ],
+      name: "",
+    }),
+  ],
+  version: "",
+})
+p api_instance.create_custom_framework(body)

examples/v2/security-monitoring/UpdateCustomFramework.rb

@@ -0,0 +1,24 @@
+# Update a custom framework returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+body = DatadogAPIClient::V2::UpdateCustomFrameworkRequest.new({
+  handle: "",
+  name: "",
+  requirements: [
+    DatadogAPIClient::V2::FrameworkRequirement.new({
+      controls: [
+        DatadogAPIClient::V2::FrameworkControl.new({
+          name: "",
+          rule_ids: [
+            "",
+          ],
+        }),
+      ],
+      name: "",
+    }),
+  ],
+  version: "",
+})
+p api_instance.update_custom_framework("handle", "version", body)