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

lib/datadog_api_client/v2/models/deployment_gates_evaluation_result_response_attributes.rb

@@ -33,10 +33,10 @@ class DeploymentGatesEvaluationResultResponseAttributes
     # The unique identifier of the deployment gate.
     attr_reader :gate_id
 
-    # 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.
     attr_reader :gate_status
 
     # The results of individual rule evaluations.

lib/datadog_api_client/v2/models/deployment_gates_evaluation_result_response_attributes_gate_status.rb

@@ -17,10 +17,10 @@
 require 'time'
 
 module DatadogAPIClient::V2
-  # 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.
   class DeploymentGatesEvaluationResultResponseAttributesGateStatus
     include BaseEnumModel
 

lib/datadog_api_client/v2/models/deployment_gates_rule_response.rb

@@ -30,10 +30,10 @@ class DeploymentGatesRuleResponse
     # The reason for the rule result, if applicable.
     attr_accessor :reason
 
-    # 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.
     attr_accessor :status
 
     attr_accessor :additional_properties