Document Deployment Gate evaluation APIs

.generator/schemas/v2/openapi.yaml

@@ -35090,10 +35090,10 @@ components:
       type: object
     DeploymentGatesEvaluationResultResponseAttributesGateStatus:
       description: |-
-        The overall status of the gate evaluation.
+        The recorded result of a gate or rule evaluation.
         - `in_progress`: The evaluation is still running.
-        - `pass`: All rules passed successfully and the deployment is allowed to proceed.
-        - `fail`: One or more rules did not pass; the deployment should not proceed.
+        - `pass`: All rules passed successfully.
+        - `fail`: One or more rules did not pass.
       enum:
         - in_progress
         - pass

src/datadog_api_client/v2/model/deployment_gates_evaluation_result_response_attributes.py

@@ -70,11 +70,11 @@ def __init__(
         :param gate_id: The unique identifier of the deployment gate.
         :type gate_id: UUID
 
-        :param gate_status: The overall status of the gate evaluation.
+        :param gate_status: The recorded result of a gate or rule evaluation.
 
             * ``in_progress`` : The evaluation is still running.
-            * ``pass`` : All rules passed successfully and the deployment is allowed to proceed.
-            * ``fail`` : One or more rules did not pass; the deployment should not proceed.
+            * ``pass`` : All rules passed successfully.
+            * ``fail`` : One or more rules did not pass.
         :type gate_status: DeploymentGatesEvaluationResultResponseAttributesGateStatus
 
         :param rules: The results of individual rule evaluations.

src/datadog_api_client/v2/model/deployment_gates_evaluation_result_response_attributes_gate_status.py

@@ -14,10 +14,10 @@
 
 class DeploymentGatesEvaluationResultResponseAttributesGateStatus(ModelSimple):
     """
-    The overall status of the gate evaluation.
+    The recorded result of a gate or rule evaluation.
         - `in_progress`: The evaluation is still running.
-        - `pass`: All rules passed successfully and the deployment is allowed to proceed.
-        - `fail`: One or more rules did not pass; the deployment should not proceed.
+        - `pass`: All rules passed successfully.
+        - `fail`: One or more rules did not pass.
 
     :param value: Must be one of ["in_progress", "pass", "fail"].
     :type value: str

src/datadog_api_client/v2/model/deployment_gates_rule_response.py

@@ -60,11 +60,11 @@ def __init__(
         :param reason: The reason for the rule result, if applicable.
         :type reason: str, optional
 
-        :param status: The overall status of the gate evaluation.
+        :param status: The recorded result of a gate or rule evaluation.
 
             * ``in_progress`` : The evaluation is still running.
-            * ``pass`` : All rules passed successfully and the deployment is allowed to proceed.
-            * ``fail`` : One or more rules did not pass; the deployment should not proceed.
+            * ``pass`` : All rules passed successfully.
+            * ``fail`` : One or more rules did not pass.
         :type status: DeploymentGatesEvaluationResultResponseAttributesGateStatus, optional
         """
         if dry_run is not unset: