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

packages/datadog-api-client-v2/models/DeploymentGatesEvaluationResultResponseAttributes.ts

@@ -29,10 +29,10 @@ export class DeploymentGatesEvaluationResultResponseAttributes {
    */
   "gateId": string;
   /**
-   * 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.
    */
   "gateStatus": DeploymentGatesEvaluationResultResponseAttributesGateStatus;
   /**

packages/datadog-api-client-v2/models/DeploymentGatesEvaluationResultResponseAttributesGateStatus.ts

@@ -7,10 +7,10 @@
 import { UnparsedObject } from "../../datadog-api-client-common/util";
 
 /**
- * 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.
  */
 
 export type DeploymentGatesEvaluationResultResponseAttributesGateStatus =

packages/datadog-api-client-v2/models/DeploymentGatesRuleResponse.ts

@@ -24,10 +24,10 @@ export class DeploymentGatesRuleResponse {
    */
   "reason"?: string;
   /**
-   * 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.
    */
   "status"?: DeploymentGatesEvaluationResultResponseAttributesGateStatus;