Regenerate client from commit 48a18d90 of spec repo

ci.datadog-api-spec · ci.datadog-api-spec · commit 1f8fa5b73f7d · 2025-01-13T20:56:37.000Z
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-13 18:28:06.332663",
-            "spec_repo_commit": "3517c947"
+            "regenerated": "2025-01-13 20:56:07.964724",
+            "spec_repo_commit": "48a18d90"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-13 18:28:06.347841",
-            "spec_repo_commit": "3517c947"
+            "regenerated": "2025-01-13 20:56:07.980362",
+            "spec_repo_commit": "48a18d90"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -213,6 +213,13 @@ components:
       required: true
       schema:
         type: string
+    CustomFrameworksOrgID:
+      description: The ID of the organization.
+      in: path
+      name: org_id
+      required: true
+      schema:
+        type: string
     EntityID:
       description: UUID or Entity Ref.
       in: path
@@ -8375,6 +8382,51 @@ components:
             $ref: '#/components/schemas/CustomDestinationResponseDefinition'
           type: array
       type: object
+    CustomFrameworkMetadata:
+      description: Response object for an organization's custom frameworks.
+      properties:
+        created_at:
+          description: Framework Creation Date
+          format: int64
+          type: integer
+        created_by:
+          description: Framework Creator
+          type: string
+        description:
+          description: Framework Description
+          type: string
+        handle:
+          description: Framework Handle
+          example: ''
+          type: string
+        id:
+          description: Custom Framework ID
+          example: ''
+          type: string
+        name:
+          description: Framework Name
+          example: ''
+          type: string
+        org_id:
+          description: Org ID
+          example: 0
+          format: int64
+          type: integer
+        updated_at:
+          description: Framework Update Date
+          format: int64
+          type: integer
+        version:
+          description: Framework Version
+          example: ''
+          type: string
+      required:
+      - id
+      - org_id
+      - handle
+      - version
+      - name
+      type: object
     DORADeploymentRequest:
       description: Request to create a DORA deployment event.
       properties:
@@ -23390,6 +23442,15 @@ components:
       x-enum-varnames:
       - REQUIRE
       - SUPPRESS
+    SecurityMonitoringListCustomFrameworksResponse:
+      description: List of historical jobs.
+      properties:
+        data:
+          description: Array containing the list of custom frameworks.
+          items:
+            $ref: '#/components/schemas/CustomFrameworkMetadata'
+          type: array
+      type: object
     SecurityMonitoringListRulesResponse:
       description: List of rules.
       properties:
@@ -40135,6 +40196,37 @@ paths:
         operator: OR
         permissions:
         - org_management
+  /api/v2/orgs/{org_id}/cloud_security_management/custom_frameworks:
+    get:
+      description: List custom frameworks.
+      operationId: ListCustomFrameworks
+      parameters:
+      - $ref: '#/components/parameters/CustomFrameworksOrgID'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SecurityMonitoringListCustomFrameworksResponse'
+          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
+      summary: List custom frameworks
+      tags:
+      - Security Monitoring
+      x-permission:
+        operator: OR
+        permissions:
+        - security_monitoring_rules_read
   /api/v2/permissions:
     get:
       description: Returns a list of all permissions, including name, description,
diff --git a/examples/v2/security-monitoring/ListCustomFrameworks.rb b/examples/v2/security-monitoring/ListCustomFrameworks.rb
@@ -0,0 +1,5 @@
+# List custom frameworks returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+p api_instance.list_custom_frameworks("org_id")
diff --git a/features/scenarios_model_mapping.rb b/features/scenarios_model_mapping.rb
@@ -1726,55 +1726,8 @@
     "v2.UploadIdPMetadata" => {
             "idp_file" => "File",
     },
-    "v2.ListRoles" => {
-            "page_size" => "Integer",
-            "page_number" => "Integer",
-            "sort" => "RolesSort",
-            "filter" => "String",
-            "filter_id" => "String",
-    },
-    "v2.CreateRole" => {
-            "body" => "RoleCreateRequest",
-    },
-    "v2.DeleteRole" => {
-            "role_id" => "String",
-    },
-    "v2.GetRole" => {
-            "role_id" => "String",
-    },
-    "v2.UpdateRole" => {
-            "role_id" => "String",
-            "body" => "RoleUpdateRequest",
-    },
-    "v2.CloneRole" => {
-            "role_id" => "String",
-            "body" => "RoleCloneRequest",
-    },
-    "v2.RemovePermissionFromRole" => {
-            "role_id" => "String",
-            "body" => "RelationshipToPermission",
-    },
-    "v2.ListRolePermissions" => {
-            "role_id" => "String",
-    },
-    "v2.AddPermissionToRole" => {
-            "role_id" => "String",
-            "body" => "RelationshipToPermission",
-    },
-    "v2.RemoveUserFromRole" => {
-            "role_id" => "String",
-            "body" => "RelationshipToUser",
-    },
-    "v2.ListRoleUsers" => {
-            "role_id" => "String",
-            "page_size" => "Integer",
-            "page_number" => "Integer",
-            "sort" => "String",
-            "filter" => "String",
-    },
-    "v2.AddUserToRole" => {
-            "role_id" => "String",
-            "body" => "RelationshipToUser",
+    "v2.ListCustomFrameworks" => {
+            "org_id" => "String",
     },
     "v2.ListFindings" => {
             "page_limit" => "Integer",
@@ -1964,6 +1917,56 @@
     "v2.CancelHistoricalJob" => {
             "job_id" => "String",
     },
+    "v2.ListRoles" => {
+            "page_size" => "Integer",
+            "page_number" => "Integer",
+            "sort" => "RolesSort",
+            "filter" => "String",
+            "filter_id" => "String",
+    },
+    "v2.CreateRole" => {
+            "body" => "RoleCreateRequest",
+    },
+    "v2.DeleteRole" => {
+            "role_id" => "String",
+    },
+    "v2.GetRole" => {
+            "role_id" => "String",
+    },
+    "v2.UpdateRole" => {
+            "role_id" => "String",
+            "body" => "RoleUpdateRequest",
+    },
+    "v2.CloneRole" => {
+            "role_id" => "String",
+            "body" => "RoleCloneRequest",
+    },
+    "v2.RemovePermissionFromRole" => {
+            "role_id" => "String",
+            "body" => "RelationshipToPermission",
+    },
+    "v2.ListRolePermissions" => {
+            "role_id" => "String",
+    },
+    "v2.AddPermissionToRole" => {
+            "role_id" => "String",
+            "body" => "RelationshipToPermission",
+    },
+    "v2.RemoveUserFromRole" => {
+            "role_id" => "String",
+            "body" => "RelationshipToUser",
+    },
+    "v2.ListRoleUsers" => {
+            "role_id" => "String",
+            "page_size" => "Integer",
+            "page_number" => "Integer",
+            "sort" => "String",
+            "filter" => "String",
+    },
+    "v2.AddUserToRole" => {
+            "role_id" => "String",
+            "body" => "RelationshipToUser",
+    },
     "v2.ListPowerpacks" => {
             "page_limit" => "Integer",
             "page_offset" => "Integer",
diff --git a/features/v2/security_monitoring.feature b/features/v2/security_monitoring.feature
@@ -572,6 +572,20 @@ Feature: Security Monitoring
     When the request is sent
     Then the response status is 200 OK
 
+  @generated @skip @team:DataDog/k9-cloud-security-platform
+  Scenario: List custom frameworks returns "Bad Request" response
+    Given new "ListCustomFrameworks" request
+    And request contains "org_id" parameter from "REPLACE.ME"
+    When the request is sent
+    Then the response status is 400 Bad Request
+
+  @generated @skip @team:DataDog/k9-cloud-security-platform
+  Scenario: List custom frameworks returns "OK" response
+    Given new "ListCustomFrameworks" request
+    And request contains "org_id" parameter from "REPLACE.ME"
+    When the request is sent
+    Then the response status is 200 OK
+
   @generated @skip @team:DataDog/cloud-security-posture-management
   Scenario: List findings returns "Bad Request: The server cannot process the request due to invalid syntax in the request." response
     Given operation "ListFindings" enabled
diff --git a/features/v2/undo.json b/features/v2/undo.json
@@ -1651,6 +1651,12 @@
       "type": "idempotent"
     }
   },
+  "ListCustomFrameworks": {
+    "tag": "Security Monitoring",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "ListPermissions": {
     "tag": "Roles",
     "undo": {
diff --git a/lib/datadog_api_client/inflector.rb b/lib/datadog_api_client/inflector.rb
@@ -1373,6 +1373,7 @@ def overrides
           "v2.custom_destination_update_request" => "CustomDestinationUpdateRequest",
           "v2.custom_destination_update_request_attributes" => "CustomDestinationUpdateRequestAttributes",
           "v2.custom_destination_update_request_definition" => "CustomDestinationUpdateRequestDefinition",
+          "v2.custom_framework_metadata" => "CustomFrameworkMetadata",
           "v2.cvss" => "CVSS",
           "v2.dashboard_list_add_items_request" => "DashboardListAddItemsRequest",
           "v2.dashboard_list_add_items_response" => "DashboardListAddItemsResponse",
@@ -2370,6 +2371,7 @@ def overrides
           "v2.security_filter_update_request" => "SecurityFilterUpdateRequest",
           "v2.security_monitoring_filter" => "SecurityMonitoringFilter",
           "v2.security_monitoring_filter_action" => "SecurityMonitoringFilterAction",
+          "v2.security_monitoring_list_custom_frameworks_response" => "SecurityMonitoringListCustomFrameworksResponse",
           "v2.security_monitoring_list_rules_response" => "SecurityMonitoringListRulesResponse",
           "v2.security_monitoring_reference_table" => "SecurityMonitoringReferenceTable",
           "v2.security_monitoring_rule_case" => "SecurityMonitoringRuleCase",
diff --git a/lib/datadog_api_client/v2/api/security_monitoring_api.rb b/lib/datadog_api_client/v2/api/security_monitoring_api.rb
@@ -1397,6 +1397,71 @@ def get_security_monitoring_suppression_with_http_info(suppression_id, opts = {}
       return data, status_code, headers
     end
 
+    # List custom frameworks.
+    #
+    # @see #list_custom_frameworks_with_http_info
+    def list_custom_frameworks(org_id, opts = {})
+      data, _status_code, _headers = list_custom_frameworks_with_http_info(org_id, opts)
+      data
+    end
+
+    # List custom frameworks.
+    #
+    # List custom frameworks.
+    #
+    # @param org_id [String] The ID of the organization.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(SecurityMonitoringListCustomFrameworksResponse, Integer, Hash)>] SecurityMonitoringListCustomFrameworksResponse data, response status code and response headers
+    def list_custom_frameworks_with_http_info(org_id, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.list_custom_frameworks ...'
+      end
+      # verify the required parameter 'org_id' is set
+      if @api_client.config.client_side_validation && org_id.nil?
+        fail ArgumentError, "Missing the required parameter 'org_id' when calling SecurityMonitoringAPI.list_custom_frameworks"
+      end
+      # resource path
+      local_var_path = '/api/v2/orgs/{org_id}/cloud_security_management/custom_frameworks'.sub('{org_id}', CGI.escape(org_id.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SecurityMonitoringListCustomFrameworksResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :list_custom_frameworks,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SecurityMonitoringAPI#list_custom_frameworks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List findings.
     #
     # @see #list_findings_with_http_info
diff --git a/lib/datadog_api_client/v2/models/custom_framework_metadata.rb b/lib/datadog_api_client/v2/models/custom_framework_metadata.rb
diff --git a/lib/datadog_api_client/v2/models/security_monitoring_list_custom_frameworks_response.rb b/lib/datadog_api_client/v2/models/security_monitoring_list_custom_frameworks_response.rb

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-01-13 18:28:06.332663",`
`8`		`- "spec_repo_commit": "3517c947"`
	`7`	`+ "regenerated": "2025-01-13 20:56:07.964724",`
	`8`	`+ "spec_repo_commit": "48a18d90"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2025-01-13 18:28:06.347841",`
`13`		`- "spec_repo_commit": "3517c947"`
	`12`	`+ "regenerated": "2025-01-13 20:56:07.980362",`
	`13`	`+ "spec_repo_commit": "48a18d90"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`