Add PUT endpoint to scorecards APIs (#2081)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-07-30 19:24:55.550204",
-            "spec_repo_commit": "edbd396a"
+            "regenerated": "2024-08-01 14:34:28.948043",
+            "spec_repo_commit": "d28278c6"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-07-30 19:24:55.567305",
-            "spec_repo_commit": "edbd396a"
+            "regenerated": "2024-08-01 14:34:28.967083",
+            "spec_repo_commit": "d28278c6"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -464,7 +464,7 @@ components:
       schema:
         type: string
     RuleId:
-      description: The ID of the rule/scorecard.
+      description: The ID of the rule.
       in: path
       name: rule_id
       required: true
@@ -16546,7 +16546,7 @@ components:
       properties:
         id:
           description: The unique ID for a scorecard.
-          example: 00000000-0000-beef-0000-000000000000
+          example: q8MQxk8TCqrHnWkp
           type: string
         type:
           $ref: '#/components/schemas/ScorecardType'
@@ -17391,7 +17391,7 @@ components:
       type: object
     RuleId:
       description: The unique ID for a scorecard rule.
-      example: 00000000-0000-beef-0000-000000000000
+      example: q8MQxk8TCqrHnWkx
       type: string
     RuleOutcomeRelationships:
       description: The JSON:API relationship to a scorecard rule.
@@ -23230,6 +23230,38 @@ components:
         id:
           $ref: '#/components/schemas/ApiID'
       type: object
+    UpdateRuleRequest:
+      description: Request to update a scorecard rule.
+      properties:
+        data:
+          $ref: '#/components/schemas/UpdateRuleRequestData'
+      type: object
+    UpdateRuleRequestData:
+      description: Data for the request to update a scorecard rule.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/RuleAttributes'
+        type:
+          $ref: '#/components/schemas/RuleType'
+      type: object
+    UpdateRuleResponse:
+      description: The response from a rule update request.
+      properties:
+        data:
+          $ref: '#/components/schemas/UpdateRuleResponseData'
+      type: object
+    UpdateRuleResponseData:
+      description: The data for a rule update response.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/RuleAttributes'
+        id:
+          $ref: '#/components/schemas/RuleId'
+        relationships:
+          $ref: '#/components/schemas/RelationshipToRule'
+        type:
+          $ref: '#/components/schemas/RuleType'
+      type: object
     UsageApplicationSecurityMonitoringResponse:
       description: Application Security Monitoring usage response.
       properties:
@@ -33671,6 +33703,43 @@ paths:
       x-unstable: '**Note**: This endpoint is in public beta.
 
         If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+    put:
+      description: Updates an existing rule.
+      operationId: UpdateScorecardRule
+      parameters:
+      - $ref: '#/components/parameters/RuleId'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdateRuleRequest'
+        description: Rule attributes.
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UpdateRuleResponse'
+          description: Rule updated successfully
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/ForbiddenResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - apm_service_catalog_write
+      summary: Update an existing rule
+      tags:
+      - Service Scorecards
+      x-codegen-request-body-name: body
+      x-unstable: '**Note**: This endpoint is in public beta.
+
+        If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
   /api/v2/security/cloud_workload/policy/download:
     get:
       description: 'The download endpoint generates a Cloud Workload Security policy
@@ -38387,8 +38456,8 @@ tags:
 
     and improve communication with internal and external users.'
   name: Service Level Objectives
-- description: 'API to create, update scorecard rules and outcomes. See [Service Scorecards](https://docs.datadoghq.com/service_catalog/scorecards)
-    for more information.
+- description: 'API to create and update scorecard rules and outcomes. See [Service
+    Scorecards](https://docs.datadoghq.com/service_catalog/scorecards) for more information.
 
 
     This feature is currently in BETA. If you have any feedback, contact [Datadog

docs/datadog_api_client.v2.model.rst

@@ -10371,6 +10371,34 @@ datadog\_api\_client.v2.model.update\_open\_api\_response\_data module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.update\_rule\_request module
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.update_rule_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.update\_rule\_request\_data module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.update_rule_request_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.update\_rule\_response module
+-----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.update_rule_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.update\_rule\_response\_data module
+-----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.update_rule_response_data
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.usage\_application\_security\_monitoring\_response module
 ---------------------------------------------------------------------------------------
 

examples/v2/service-scorecards/UpdateScorecardRule.py

@@ -0,0 +1,34 @@
+"""
+Update an existing rule returns "Rule updated successfully" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.service_scorecards_api import ServiceScorecardsApi
+from datadog_api_client.v2.model.rule_attributes import RuleAttributes
+from datadog_api_client.v2.model.update_rule_request import UpdateRuleRequest
+from datadog_api_client.v2.model.update_rule_request_data import UpdateRuleRequestData
+
+# there is a valid "create_scorecard_rule" in the system
+CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME = environ["CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME"]
+CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME = environ["CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME"]
+CREATE_SCORECARD_RULE_DATA_ID = environ["CREATE_SCORECARD_RULE_DATA_ID"]
+
+body = UpdateRuleRequest(
+    data=UpdateRuleRequestData(
+        attributes=RuleAttributes(
+            enabled=True,
+            name=CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME,
+            scorecard_name=CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME,
+            description="Updated description via test",
+        ),
+    ),
+)
+
+configuration = Configuration()
+configuration.unstable_operations["update_scorecard_rule"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = ServiceScorecardsApi(api_client)
+    response = api_instance.update_scorecard_rule(rule_id=CREATE_SCORECARD_RULE_DATA_ID, body=body)
+
+    print(response)

src/datadog_api_client/configuration.py

@@ -273,6 +273,7 @@ def __init__(
                 "v2.delete_scorecard_rule": False,
                 "v2.list_scorecard_outcomes": False,
                 "v2.list_scorecard_rules": False,
+                "v2.update_scorecard_rule": False,
                 "v2.create_incident_service": False,
                 "v2.delete_incident_service": False,
                 "v2.get_incident_service": False,

src/datadog_api_client/v2/api/service_scorecards_api.py

@@ -22,11 +22,13 @@
 from datadog_api_client.v2.model.list_rules_response_data_item import ListRulesResponseDataItem
 from datadog_api_client.v2.model.create_rule_response import CreateRuleResponse
 from datadog_api_client.v2.model.create_rule_request import CreateRuleRequest
+from datadog_api_client.v2.model.update_rule_response import UpdateRuleResponse
+from datadog_api_client.v2.model.update_rule_request import UpdateRuleRequest
 
 
 class ServiceScorecardsApi:
     """
-    API to create, update scorecard rules and outcomes. See `Service Scorecards <https://docs.datadoghq.com/service_catalog/scorecards>`_ for more information.
+    API to create and update scorecard rules and outcomes. See `Service Scorecards <https://docs.datadoghq.com/service_catalog/scorecards>`_ for more information.
 
     This feature is currently in BETA. If you have any feedback, contact `Datadog support <https://docs.datadoghq.com/help/>`_.
     """
@@ -233,6 +235,32 @@ def __init__(self, api_client=None):
             api_client=api_client,
         )
 
+        self._update_scorecard_rule_endpoint = _Endpoint(
+            settings={
+                "response_type": (UpdateRuleResponse,),
+                "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
+                "endpoint_path": "/api/v2/scorecard/rules/{rule_id}",
+                "operation_id": "update_scorecard_rule",
+                "http_method": "PUT",
+                "version": "v2",
+            },
+            params_map={
+                "rule_id": {
+                    "required": True,
+                    "openapi_types": (str,),
+                    "attribute": "rule_id",
+                    "location": "path",
+                },
+                "body": {
+                    "required": True,
+                    "openapi_types": (UpdateRuleRequest,),
+                    "location": "body",
+                },
+            },
+            headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
+            api_client=api_client,
+        )
+
     def create_scorecard_outcomes_batch(
         self,
         body: OutcomesBatchRequest,
@@ -275,7 +303,7 @@ def delete_scorecard_rule(
 
         Deletes a single rule.
 
-        :param rule_id: The ID of the rule/scorecard.
+        :param rule_id: The ID of the rule.
         :type rule_id: str
         :rtype: None
         """
@@ -599,3 +627,25 @@ def list_scorecard_rules_with_pagination(
             "kwargs": kwargs,
         }
         return endpoint.call_with_http_info_paginated(pagination)
+
+    def update_scorecard_rule(
+        self,
+        rule_id: str,
+        body: UpdateRuleRequest,
+    ) -> UpdateRuleResponse:
+        """Update an existing rule.
+
+        Updates an existing rule.
+
+        :param rule_id: The ID of the rule.
+        :type rule_id: str
+        :param body: Rule attributes.
+        :type body: UpdateRuleRequest
+        :rtype: UpdateRuleResponse
+        """
+        kwargs: Dict[str, Any] = {}
+        kwargs["rule_id"] = rule_id
+
+        kwargs["body"] = body
+
+        return self._update_scorecard_rule_endpoint.call_with_http_info(**kwargs)

src/datadog_api_client/v2/model/update_rule_request.py

@@ -0,0 +1,42 @@
+# 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 Union, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v2.model.update_rule_request_data import UpdateRuleRequestData
+
+
+class UpdateRuleRequest(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v2.model.update_rule_request_data import UpdateRuleRequestData
+
+        return {
+            "data": (UpdateRuleRequestData,),
+        }
+
+    attribute_map = {
+        "data": "data",
+    }
+
+    def __init__(self_, data: Union[UpdateRuleRequestData, UnsetType] = unset, **kwargs):
+        """
+        Request to update a scorecard rule.
+
+        :param data: Data for the request to update a scorecard rule.
+        :type data: UpdateRuleRequestData, optional
+        """
+        if data is not unset:
+            kwargs["data"] = data
+        super().__init__(kwargs)

src/datadog_api_client/v2/model/update_rule_request_data.py

@@ -0,0 +1,53 @@
+# 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 Union, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v2.model.rule_attributes import RuleAttributes
+    from datadog_api_client.v2.model.rule_type import RuleType
+
+
+class UpdateRuleRequestData(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v2.model.rule_attributes import RuleAttributes
+        from datadog_api_client.v2.model.rule_type import RuleType
+
+        return {
+            "attributes": (RuleAttributes,),
+            "type": (RuleType,),
+        }
+
+    attribute_map = {
+        "attributes": "attributes",
+        "type": "type",
+    }
+
+    def __init__(
+        self_, attributes: Union[RuleAttributes, UnsetType] = unset, type: Union[RuleType, UnsetType] = unset, **kwargs
+    ):
+        """
+        Data for the request to update a scorecard rule.
+
+        :param attributes: Details of a rule.
+        :type attributes: RuleAttributes, optional
+
+        :param type: The JSON:API type for scorecard rules.
+        :type type: RuleType, optional
+        """
+        if attributes is not unset:
+            kwargs["attributes"] = attributes
+        if type is not unset:
+            kwargs["type"] = type
+        super().__init__(kwargs)