From 4049c4a3828ee54744199aa1de1a5111a47f12ba Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Thu, 16 Jan 2025 16:29:36 +0000 Subject: [PATCH] Regenerate client from commit b3d1b873 of spec repo --- .apigentools-info | 8 +- .generator/schemas/v2/openapi.yaml | 165 ++++++++++++++++++ docs/datadog_api_client.v2.model.rst | 28 +++ .../CreateCustomFramework.py | 34 ++++ .../UpdateCustomFramework.py | 34 ++++ src/datadog_api_client/configuration.py | 24 +-- .../v2/api/security_monitoring_api.py | 96 ++++++++++ .../model/create_custom_framework_request.py | 83 +++++++++ .../v2/model/framework_control.py | 40 +++++ .../v2/model/framework_requirement.py | 46 +++++ .../model/update_custom_framework_request.py | 83 +++++++++ src/datadog_api_client/v2/models/__init__.py | 8 + tests/v2/features/given.json | 24 +++ tests/v2/features/security_monitoring.feature | 36 ++++ tests/v2/features/undo.json | 12 ++ 15 files changed, 706 insertions(+), 15 deletions(-) create mode 100644 examples/v2/security-monitoring/CreateCustomFramework.py create mode 100644 examples/v2/security-monitoring/UpdateCustomFramework.py create mode 100644 src/datadog_api_client/v2/model/create_custom_framework_request.py create mode 100644 src/datadog_api_client/v2/model/framework_control.py create mode 100644 src/datadog_api_client/v2/model/framework_requirement.py create mode 100644 src/datadog_api_client/v2/model/update_custom_framework_request.py diff --git a/.apigentools-info b/.apigentools-info index f8c96fb524..30339dcb60 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2025-01-15 18:03:11.180859", - "spec_repo_commit": "e54847a1" + "regenerated": "2025-01-16 16:29:00.243268", + "spec_repo_commit": "b3d1b873" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2025-01-15 18:03:11.196723", - "spec_repo_commit": "e54847a1" + "regenerated": "2025-01-16 16:29:00.257838", + "spec_repo_commit": "b3d1b873" } } } \ No newline at end of file diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 77866cbe38..70d08d2f5e 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.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,83 @@ 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 + x-unstable: '**Note**: This endpoint is in beta and may be subject to changes. + + Please check the documentation regularly for updates.' + /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 + x-unstable: '**Note**: This endpoint is in beta and may be subject to changes. + + Please check the documentation regularly for updates.' /api/v2/container_images: get: description: Get all Container Images for your organization. diff --git a/docs/datadog_api_client.v2.model.rst b/docs/datadog_api_client.v2.model.rst index ba92270028..f761aff3df 100644 --- a/docs/datadog_api_client.v2.model.rst +++ b/docs/datadog_api_client.v2.model.rst @@ -2727,6 +2727,13 @@ datadog\_api\_client.v2.model.create\_app\_response\_data\_type module :members: :show-inheritance: +datadog\_api\_client.v2.model.create\_custom\_framework\_request module +----------------------------------------------------------------------- + +.. automodule:: datadog_api_client.v2.model.create_custom_framework_request + :members: + :show-inheritance: + datadog\_api\_client.v2.model.create\_data\_deletion\_request\_body module -------------------------------------------------------------------------- @@ -4883,6 +4890,20 @@ datadog\_api\_client.v2.model.formula\_limit module :members: :show-inheritance: +datadog\_api\_client.v2.model.framework\_control module +------------------------------------------------------- + +.. automodule:: datadog_api_client.v2.model.framework_control + :members: + :show-inheritance: + +datadog\_api\_client.v2.model.framework\_requirement module +----------------------------------------------------------- + +.. automodule:: datadog_api_client.v2.model.framework_requirement + :members: + :show-inheritance: + datadog\_api\_client.v2.model.full\_api\_key module --------------------------------------------------- @@ -12744,6 +12765,13 @@ datadog\_api\_client.v2.model.update\_app\_response\_relationship module :members: :show-inheritance: +datadog\_api\_client.v2.model.update\_custom\_framework\_request module +----------------------------------------------------------------------- + +.. automodule:: datadog_api_client.v2.model.update_custom_framework_request + :members: + :show-inheritance: + datadog\_api\_client.v2.model.update\_open\_api\_response module ---------------------------------------------------------------- diff --git a/examples/v2/security-monitoring/CreateCustomFramework.py b/examples/v2/security-monitoring/CreateCustomFramework.py new file mode 100644 index 0000000000..57b51a2b38 --- /dev/null +++ b/examples/v2/security-monitoring/CreateCustomFramework.py @@ -0,0 +1,34 @@ +""" +Create a custom framework returns "OK" response +""" + +from datadog_api_client import ApiClient, Configuration +from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi +from datadog_api_client.v2.model.create_custom_framework_request import CreateCustomFrameworkRequest +from datadog_api_client.v2.model.framework_control import FrameworkControl +from datadog_api_client.v2.model.framework_requirement import FrameworkRequirement + +body = CreateCustomFrameworkRequest( + handle="", + name="", + requirements=[ + FrameworkRequirement( + controls=[ + FrameworkControl( + name="", + rule_ids=[ + "", + ], + ), + ], + name="", + ), + ], + version="", +) + +configuration = Configuration() +configuration.unstable_operations["create_custom_framework"] = True +with ApiClient(configuration) as api_client: + api_instance = SecurityMonitoringApi(api_client) + api_instance.create_custom_framework(body=body) diff --git a/examples/v2/security-monitoring/UpdateCustomFramework.py b/examples/v2/security-monitoring/UpdateCustomFramework.py new file mode 100644 index 0000000000..fe2c968f62 --- /dev/null +++ b/examples/v2/security-monitoring/UpdateCustomFramework.py @@ -0,0 +1,34 @@ +""" +Update a custom framework returns "OK" response +""" + +from datadog_api_client import ApiClient, Configuration +from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi +from datadog_api_client.v2.model.framework_control import FrameworkControl +from datadog_api_client.v2.model.framework_requirement import FrameworkRequirement +from datadog_api_client.v2.model.update_custom_framework_request import UpdateCustomFrameworkRequest + +body = UpdateCustomFrameworkRequest( + handle="", + name="", + requirements=[ + FrameworkRequirement( + controls=[ + FrameworkControl( + name="", + rule_ids=[ + "", + ], + ), + ], + name="", + ), + ], + version="", +) + +configuration = Configuration() +configuration.unstable_operations["update_custom_framework"] = True +with ApiClient(configuration) as api_client: + api_instance = SecurityMonitoringApi(api_client) + api_instance.update_custom_framework(handle="handle", version="version", body=body) diff --git a/src/datadog_api_client/configuration.py b/src/datadog_api_client/configuration.py index 589443e098..1654d75cdf 100644 --- a/src/datadog_api_client/configuration.py +++ b/src/datadog_api_client/configuration.py @@ -249,6 +249,19 @@ def __init__( "v2.get_app": False, "v2.list_apps": False, "v2.update_app": False, + "v2.cancel_historical_job": False, + "v2.convert_job_result_to_signal": False, + "v2.create_custom_framework": False, + "v2.delete_historical_job": False, + "v2.get_finding": False, + "v2.get_historical_job": False, + "v2.list_findings": False, + "v2.list_historical_jobs": False, + "v2.list_vulnerabilities": False, + "v2.list_vulnerable_assets": False, + "v2.mute_findings": False, + "v2.run_historical_job": False, + "v2.update_custom_framework": False, "v2.get_active_billing_dimensions": False, "v2.get_billing_dimension_mapping": False, "v2.get_monthly_cost_attribution": False, @@ -288,17 +301,6 @@ def __init__( "v2.list_aws_namespaces": False, "v2.update_aws_account": False, "v2.list_aws_logs_services": False, - "v2.cancel_historical_job": False, - "v2.convert_job_result_to_signal": False, - "v2.delete_historical_job": False, - "v2.get_finding": False, - "v2.get_historical_job": False, - "v2.list_findings": False, - "v2.list_historical_jobs": False, - "v2.list_vulnerabilities": False, - "v2.list_vulnerable_assets": False, - "v2.mute_findings": False, - "v2.run_historical_job": False, "v2.create_scorecard_outcomes_batch": False, "v2.create_scorecard_rule": False, "v2.delete_scorecard_rule": False, diff --git a/src/datadog_api_client/v2/api/security_monitoring_api.py b/src/datadog_api_client/v2/api/security_monitoring_api.py index 2b60d768a5..349133dfbd 100644 --- a/src/datadog_api_client/v2/api/security_monitoring_api.py +++ b/src/datadog_api_client/v2/api/security_monitoring_api.py @@ -15,6 +15,8 @@ UnsetType, unset, ) +from datadog_api_client.v2.model.create_custom_framework_request import CreateCustomFrameworkRequest +from datadog_api_client.v2.model.update_custom_framework_request import UpdateCustomFrameworkRequest from datadog_api_client.v2.model.list_findings_response import ListFindingsResponse from datadog_api_client.v2.model.finding_evaluation import FindingEvaluation from datadog_api_client.v2.model.finding_status import FindingStatus @@ -182,6 +184,26 @@ def __init__(self, api_client=None): api_client=api_client, ) + self._create_custom_framework_endpoint = _Endpoint( + settings={ + "response_type": None, + "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"], + "endpoint_path": "/api/v2/cloud_security_management/custom_frameworks", + "operation_id": "create_custom_framework", + "http_method": "POST", + "version": "v2", + }, + params_map={ + "body": { + "required": True, + "openapi_types": (CreateCustomFrameworkRequest,), + "location": "body", + }, + }, + headers_map={"accept": ["*/*"], "content_type": ["application/json"]}, + api_client=api_client, + ) + self._create_security_filter_endpoint = _Endpoint( settings={ "response_type": (SecurityFilterResponse,), @@ -1231,6 +1253,38 @@ def __init__(self, api_client=None): api_client=api_client, ) + self._update_custom_framework_endpoint = _Endpoint( + settings={ + "response_type": None, + "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"], + "endpoint_path": "/api/v2/cloud_security_management/custom_frameworks/{handle}/{version}", + "operation_id": "update_custom_framework", + "http_method": "PUT", + "version": "v2", + }, + params_map={ + "handle": { + "required": True, + "openapi_types": (str,), + "attribute": "handle", + "location": "path", + }, + "version": { + "required": True, + "openapi_types": (str,), + "attribute": "version", + "location": "path", + }, + "body": { + "required": True, + "openapi_types": (UpdateCustomFrameworkRequest,), + "location": "body", + }, + }, + headers_map={"accept": ["*/*"], "content_type": ["application/json"]}, + api_client=api_client, + ) + self._update_security_filter_endpoint = _Endpoint( settings={ "response_type": (SecurityFilterResponse,), @@ -1401,6 +1455,22 @@ def convert_security_monitoring_rule_from_json_to_terraform( return self._convert_security_monitoring_rule_from_json_to_terraform_endpoint.call_with_http_info(**kwargs) + def create_custom_framework( + self, + body: CreateCustomFrameworkRequest, + ) -> None: + """Create a custom framework. + + Create a custom framework. + + :type body: CreateCustomFrameworkRequest + :rtype: None + """ + kwargs: Dict[str, Any] = {} + kwargs["body"] = body + + return self._create_custom_framework_endpoint.call_with_http_info(**kwargs) + def create_security_filter( self, body: SecurityFilterCreateRequest, @@ -2713,6 +2783,32 @@ def test_security_monitoring_rule( return self._test_security_monitoring_rule_endpoint.call_with_http_info(**kwargs) + def update_custom_framework( + self, + handle: str, + version: str, + body: UpdateCustomFrameworkRequest, + ) -> None: + """Update a custom framework. + + Update a custom framework. + + :param handle: The framework handle + :type handle: str + :param version: The framework version + :type version: str + :type body: UpdateCustomFrameworkRequest + :rtype: None + """ + kwargs: Dict[str, Any] = {} + kwargs["handle"] = handle + + kwargs["version"] = version + + kwargs["body"] = body + + return self._update_custom_framework_endpoint.call_with_http_info(**kwargs) + def update_security_filter( self, security_filter_id: str, diff --git a/src/datadog_api_client/v2/model/create_custom_framework_request.py b/src/datadog_api_client/v2/model/create_custom_framework_request.py new file mode 100644 index 0000000000..fb9806ecbf --- /dev/null +++ b/src/datadog_api_client/v2/model/create_custom_framework_request.py @@ -0,0 +1,83 @@ +# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. +# This product includes software developed at Datadog (https://www.datadoghq.com/). +# Copyright 2019-Present Datadog, Inc. +from __future__ import annotations + +from typing import List, Union, TYPE_CHECKING + +from datadog_api_client.model_utils import ( + ModelNormal, + cached_property, + unset, + UnsetType, +) + + +if TYPE_CHECKING: + from datadog_api_client.v2.model.framework_requirement import FrameworkRequirement + + +class CreateCustomFrameworkRequest(ModelNormal): + @cached_property + def openapi_types(_): + from datadog_api_client.v2.model.framework_requirement import FrameworkRequirement + + return { + "description": (str,), + "handle": (str,), + "icon_url": (str,), + "name": (str,), + "requirements": ([FrameworkRequirement],), + "version": (str,), + } + + attribute_map = { + "description": "description", + "handle": "handle", + "icon_url": "icon_url", + "name": "name", + "requirements": "requirements", + "version": "version", + } + + def __init__( + self_, + handle: str, + name: str, + requirements: List[FrameworkRequirement], + version: str, + description: Union[str, UnsetType] = unset, + icon_url: Union[str, UnsetType] = unset, + **kwargs, + ): + """ + Framework Data. + + :param description: Framework Description + :type description: str, optional + + :param handle: Framework Handle + :type handle: str + + :param icon_url: Framework Icon URL + :type icon_url: str, optional + + :param name: Framework Name + :type name: str + + :param requirements: Framework Requirements + :type requirements: [FrameworkRequirement] + + :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_.handle = handle + self_.name = name + self_.requirements = requirements + self_.version = version diff --git a/src/datadog_api_client/v2/model/framework_control.py b/src/datadog_api_client/v2/model/framework_control.py new file mode 100644 index 0000000000..e314a8addd --- /dev/null +++ b/src/datadog_api_client/v2/model/framework_control.py @@ -0,0 +1,40 @@ +# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. +# This product includes software developed at Datadog (https://www.datadoghq.com/). +# Copyright 2019-Present Datadog, Inc. +from __future__ import annotations + +from typing import List + +from datadog_api_client.model_utils import ( + ModelNormal, + cached_property, +) + + +class FrameworkControl(ModelNormal): + @cached_property + def openapi_types(_): + return { + "name": (str,), + "rule_ids": ([str],), + } + + attribute_map = { + "name": "name", + "rule_ids": "rule_ids", + } + + def __init__(self_, name: str, rule_ids: List[str], **kwargs): + """ + Framework Control. + + :param name: Control Name. + :type name: str + + :param rule_ids: Rule IDs. + :type rule_ids: [str] + """ + super().__init__(kwargs) + + self_.name = name + self_.rule_ids = rule_ids diff --git a/src/datadog_api_client/v2/model/framework_requirement.py b/src/datadog_api_client/v2/model/framework_requirement.py new file mode 100644 index 0000000000..9af588ce9b --- /dev/null +++ b/src/datadog_api_client/v2/model/framework_requirement.py @@ -0,0 +1,46 @@ +# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. +# This product includes software developed at Datadog (https://www.datadoghq.com/). +# Copyright 2019-Present Datadog, Inc. +from __future__ import annotations + +from typing import List, TYPE_CHECKING + +from datadog_api_client.model_utils import ( + ModelNormal, + cached_property, +) + + +if TYPE_CHECKING: + from datadog_api_client.v2.model.framework_control import FrameworkControl + + +class FrameworkRequirement(ModelNormal): + @cached_property + def openapi_types(_): + from datadog_api_client.v2.model.framework_control import FrameworkControl + + return { + "controls": ([FrameworkControl],), + "name": (str,), + } + + attribute_map = { + "controls": "controls", + "name": "name", + } + + def __init__(self_, controls: List[FrameworkControl], name: str, **kwargs): + """ + Framework Requirement. + + :param controls: Requirement Controls. + :type controls: [FrameworkControl] + + :param name: Requirement Name. + :type name: str + """ + super().__init__(kwargs) + + self_.controls = controls + self_.name = name diff --git a/src/datadog_api_client/v2/model/update_custom_framework_request.py b/src/datadog_api_client/v2/model/update_custom_framework_request.py new file mode 100644 index 0000000000..f79cad949f --- /dev/null +++ b/src/datadog_api_client/v2/model/update_custom_framework_request.py @@ -0,0 +1,83 @@ +# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. +# This product includes software developed at Datadog (https://www.datadoghq.com/). +# Copyright 2019-Present Datadog, Inc. +from __future__ import annotations + +from typing import List, Union, TYPE_CHECKING + +from datadog_api_client.model_utils import ( + ModelNormal, + cached_property, + unset, + UnsetType, +) + + +if TYPE_CHECKING: + from datadog_api_client.v2.model.framework_requirement import FrameworkRequirement + + +class UpdateCustomFrameworkRequest(ModelNormal): + @cached_property + def openapi_types(_): + from datadog_api_client.v2.model.framework_requirement import FrameworkRequirement + + return { + "description": (str,), + "handle": (str,), + "icon_url": (str,), + "name": (str,), + "requirements": ([FrameworkRequirement],), + "version": (str,), + } + + attribute_map = { + "description": "description", + "handle": "handle", + "icon_url": "icon_url", + "name": "name", + "requirements": "requirements", + "version": "version", + } + + def __init__( + self_, + handle: str, + name: str, + requirements: List[FrameworkRequirement], + version: str, + description: Union[str, UnsetType] = unset, + icon_url: Union[str, UnsetType] = unset, + **kwargs, + ): + """ + Framework Data. + + :param description: Framework Description + :type description: str, optional + + :param handle: Framework Handle + :type handle: str + + :param icon_url: Framework Icon URL + :type icon_url: str, optional + + :param name: Framework Name + :type name: str + + :param requirements: Framework Requirements + :type requirements: [FrameworkRequirement] + + :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_.handle = handle + self_.name = name + self_.requirements = requirements + self_.version = version diff --git a/src/datadog_api_client/v2/models/__init__.py b/src/datadog_api_client/v2/models/__init__.py index d0f3eee4b2..cb4131ed8f 100644 --- a/src/datadog_api_client/v2/models/__init__.py +++ b/src/datadog_api_client/v2/models/__init__.py @@ -455,6 +455,7 @@ from datadog_api_client.v2.model.create_app_response import CreateAppResponse from datadog_api_client.v2.model.create_app_response_data import CreateAppResponseData from datadog_api_client.v2.model.create_app_response_data_type import CreateAppResponseDataType +from datadog_api_client.v2.model.create_custom_framework_request import CreateCustomFrameworkRequest from datadog_api_client.v2.model.create_data_deletion_request_body import CreateDataDeletionRequestBody from datadog_api_client.v2.model.create_data_deletion_request_body_attributes import ( CreateDataDeletionRequestBodyAttributes, @@ -865,6 +866,8 @@ from datadog_api_client.v2.model.finding_type import FindingType from datadog_api_client.v2.model.finding_vulnerability_type import FindingVulnerabilityType from datadog_api_client.v2.model.formula_limit import FormulaLimit +from datadog_api_client.v2.model.framework_control import FrameworkControl +from datadog_api_client.v2.model.framework_requirement import FrameworkRequirement from datadog_api_client.v2.model.full_api_key import FullAPIKey from datadog_api_client.v2.model.full_api_key_attributes import FullAPIKeyAttributes from datadog_api_client.v2.model.full_application_key import FullApplicationKey @@ -2228,6 +2231,7 @@ from datadog_api_client.v2.model.update_app_response_data_attributes import UpdateAppResponseDataAttributes from datadog_api_client.v2.model.update_app_response_data_type import UpdateAppResponseDataType from datadog_api_client.v2.model.update_app_response_relationship import UpdateAppResponseRelationship +from datadog_api_client.v2.model.update_custom_framework_request import UpdateCustomFrameworkRequest from datadog_api_client.v2.model.update_open_api_response import UpdateOpenAPIResponse from datadog_api_client.v2.model.update_open_api_response_attributes import UpdateOpenAPIResponseAttributes from datadog_api_client.v2.model.update_open_api_response_data import UpdateOpenAPIResponseData @@ -2721,6 +2725,7 @@ "CreateAppResponse", "CreateAppResponseData", "CreateAppResponseDataType", + "CreateCustomFrameworkRequest", "CreateDataDeletionRequestBody", "CreateDataDeletionRequestBodyAttributes", "CreateDataDeletionRequestBodyData", @@ -3027,6 +3032,8 @@ "FindingType", "FindingVulnerabilityType", "FormulaLimit", + "FrameworkControl", + "FrameworkRequirement", "FullAPIKey", "FullAPIKeyAttributes", "FullApplicationKey", @@ -4154,6 +4161,7 @@ "UpdateAppResponseDataAttributes", "UpdateAppResponseDataType", "UpdateAppResponseRelationship", + "UpdateCustomFrameworkRequest", "UpdateOpenAPIResponse", "UpdateOpenAPIResponseAttributes", "UpdateOpenAPIResponseData", diff --git a/tests/v2/features/given.json b/tests/v2/features/given.json index 3c9e427938..0bc5869fc9 100644 --- a/tests/v2/features/given.json +++ b/tests/v2/features/given.json @@ -96,6 +96,30 @@ "tag": "Software Catalog", "operationId": "UpsertCatalogEntity" }, + { + "parameters": [ + { + "name": "body", + "value": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"handle\": \"handle\",\n \"version\": \"version\",\n \"requirements\": [\n {\n \"name\": requirement\",\n \"controls\": [\n {\n \"name\": \"control\",\n \"rule_ids\": [\"rule_id\"]\n }\n ]\n }\n ]\n}" + } + ], + "step": "there is a valid \"custom_framework\" in the system", + "key": "custom_framework", + "tag": "Security Monitoring", + "operationId": "CreateCustomFramework" + }, + { + "parameters": [ + { + "name": "body", + "value": "{\n \"name\": \"name\",\n \"description\": \"description\",\n \"handle\": \"handle\",\n \"version\": \"version\",\n \"requirements\": [\n {\n \"name\": requirement\",\n \"controls\": [\n {\n \"name\": \"control\",\n \"rule_ids\": [\"rule_id\"]\n }\n ]\n }\n ]\n}" + } + ], + "step": "there is a valid \"custom_framework\" in the system", + "key": "custom_framework", + "tag": "Security Monitoring", + "operationId": "UpdateCustomFramework" + }, { "parameters": [ { diff --git a/tests/v2/features/security_monitoring.feature b/tests/v2/features/security_monitoring.feature index 362378f634..c00fa9d0a4 100644 --- a/tests/v2/features/security_monitoring.feature +++ b/tests/v2/features/security_monitoring.feature @@ -171,6 +171,22 @@ Feature: Security Monitoring And the response "message" is equal to "ddd" And the response "options.complianceRuleOptions.resourceType" is equal to "gcp_compute_disk" + @generated @skip @team:DataDog/k9-cloud-security-platform + Scenario: Create a custom framework returns "Bad Request" response + Given operation "CreateCustomFramework" enabled + And new "CreateCustomFramework" request + And body with value {"handle": "", "name": "", "requirements": [{"controls": [{"name": "", "rule_ids": [""]}], "name": ""}], "version": ""} + When the request is sent + Then the response status is 400 Bad Request + + @generated @skip @team:DataDog/k9-cloud-security-platform + Scenario: Create a custom framework returns "OK" response + Given operation "CreateCustomFramework" enabled + And new "CreateCustomFramework" request + And body with value {"handle": "", "name": "", "requirements": [{"controls": [{"name": "", "rule_ids": [""]}], "name": ""}], "version": ""} + When the request is sent + Then the response status is 200 OK + @team:DataDog/k9-cloud-security-platform Scenario: Create a detection rule returns "Bad Request" response Given new "CreateSecurityMonitoringRule" request @@ -827,6 +843,26 @@ Feature: Security Monitoring And the response "name" is equal to "{{ unique }}_cloud_updated" And the response "id" has the same value as "cloud_configuration_rule.id" + @generated @skip @team:DataDog/k9-cloud-security-platform + Scenario: Update a custom framework returns "Bad Request" response + Given operation "UpdateCustomFramework" enabled + And new "UpdateCustomFramework" request + And request contains "handle" parameter from "REPLACE.ME" + And request contains "version" parameter from "REPLACE.ME" + And body with value {"handle": "", "name": "", "requirements": [{"controls": [{"name": "", "rule_ids": [""]}], "name": ""}], "version": ""} + When the request is sent + Then the response status is 400 Bad Request + + @generated @skip @team:DataDog/k9-cloud-security-platform + Scenario: Update a custom framework returns "OK" response + Given operation "UpdateCustomFramework" enabled + And new "UpdateCustomFramework" request + And request contains "handle" parameter from "REPLACE.ME" + And request contains "version" parameter from "REPLACE.ME" + And body with value {"handle": "", "name": "", "requirements": [{"controls": [{"name": "", "rule_ids": [""]}], "name": ""}], "version": ""} + When the request is sent + Then the response status is 200 OK + @generated @skip @team:DataDog/k9-cloud-security-platform Scenario: Update a security filter returns "Bad Request" response Given new "UpdateSecurityFilter" request diff --git a/tests/v2/features/undo.json b/tests/v2/features/undo.json index d6c6e9de87..555e1ae15e 100644 --- a/tests/v2/features/undo.json +++ b/tests/v2/features/undo.json @@ -439,6 +439,18 @@ "type": "safe" } }, + "CreateCustomFramework": { + "tag": "Security Monitoring", + "undo": { + "type": "unsafe" + } + }, + "UpdateCustomFramework": { + "tag": "Security Monitoring", + "undo": { + "type": "idempotent" + } + }, "ListContainerImages": { "tag": "Container Images", "undo": {