Add api specs for deployment gates (#2893)

Co-authored-by: ci.datadog-api-spec <[email protected]>

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

.generator/schemas/v2/openapi.yaml

@@ -200,6 +200,13 @@ datadog\_api\_client.v2.api.datasets\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.deployment\_gates\_api module
+---------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.deployment_gates_api
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.api.domain\_allowlist\_api module
 ---------------------------------------------------------
 

docs/datadog_api_client.v2.api.rst

@@ -5030,6 +5030,48 @@ datadog\_api\_client.v2.model.create\_data\_deletion\_response\_body module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.create\_deployment\_gate\_params module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_deployment_gate_params
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.create\_deployment\_gate\_params\_data module
+---------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_deployment_gate_params_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.create\_deployment\_gate\_params\_data\_attributes module
+---------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_deployment_gate_params_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.create\_deployment\_rule\_params module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_deployment_rule_params
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.create\_deployment\_rule\_params\_data module
+---------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_deployment_rule_params_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.create\_deployment\_rule\_params\_data\_attributes module
+---------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_deployment_rule_params_data_attributes
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.create\_incident\_notification\_rule\_request module
 ----------------------------------------------------------------------------------
 
@@ -6521,6 +6563,48 @@ datadog\_api\_client.v2.model.deployment\_attributes module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.deployment\_gate\_data\_type module
+-----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_gate_data_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_gate\_response module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_gate_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_gate\_response\_data module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_gate_response_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_gate\_response\_data\_attributes module
+---------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_gate_response_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_gate\_response\_data\_attributes\_created\_by module
+----------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_gate_response_data_attributes_created_by
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_gate\_response\_data\_attributes\_updated\_by module
+----------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_gate_response_data_attributes_updated_by
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.deployment\_metadata module
 ---------------------------------------------------------
 
@@ -6542,6 +6626,76 @@ datadog\_api\_client.v2.model.deployment\_relationship\_data module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.deployment\_rule\_data\_type module
+-----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_rule_data_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_rule\_options\_faulty\_deployment\_detection module
+---------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_rule_options_faulty_deployment_detection
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_rule\_options\_monitor module
+-----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_rule_options_monitor
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_rule\_response module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_rule_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_rule\_response\_data module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_rule_response_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_rule\_response\_data\_attributes module
+---------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_rule_response_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_rule\_response\_data\_attributes\_created\_by module
+----------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_rule_response_data_attributes_created_by
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_rule\_response\_data\_attributes\_type module
+---------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_rule_response_data_attributes_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_rule\_response\_data\_attributes\_updated\_by module
+----------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_rule_response_data_attributes_updated_by
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.deployment\_rules\_options module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.deployment_rules_options
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.detailed\_finding module
 ------------------------------------------------------
 
@@ -10105,6 +10259,27 @@ datadog\_api\_client.v2.model.http\_token\_update module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.httpcd\_gates\_bad\_request\_response module
+--------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.httpcd_gates_bad_request_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.httpcd\_gates\_not\_found\_response module
+------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.httpcd_gates_not_found_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.httpcd\_rules\_not\_found\_response module
+------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.httpcd_rules_not_found_response
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.httpci\_app\_error module
 -------------------------------------------------------
 
@@ -23727,6 +23902,48 @@ datadog\_api\_client.v2.model.update\_custom\_framework\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.update\_deployment\_gate\_params module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.update_deployment_gate_params
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.update\_deployment\_gate\_params\_data module
+---------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.update_deployment_gate_params_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.update\_deployment\_gate\_params\_data\_attributes module
+---------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.update_deployment_gate_params_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.update\_deployment\_rule\_params module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.update_deployment_rule_params
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.update\_deployment\_rule\_params\_data module
+---------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.update_deployment_rule_params_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.update\_deployment\_rule\_params\_data\_attributes module
+---------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.update_deployment_rule_params_data_attributes
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.update\_open\_api\_response module
 ----------------------------------------------------------------
 

docs/datadog_api_client.v2.model.rst

@@ -0,0 +1,32 @@
+"""
+Create deployment gate returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.deployment_gates_api import DeploymentGatesApi
+from datadog_api_client.v2.model.create_deployment_gate_params import CreateDeploymentGateParams
+from datadog_api_client.v2.model.create_deployment_gate_params_data import CreateDeploymentGateParamsData
+from datadog_api_client.v2.model.create_deployment_gate_params_data_attributes import (
+    CreateDeploymentGateParamsDataAttributes,
+)
+from datadog_api_client.v2.model.deployment_gate_data_type import DeploymentGateDataType
+
+body = CreateDeploymentGateParams(
+    data=CreateDeploymentGateParamsData(
+        attributes=CreateDeploymentGateParamsDataAttributes(
+            dry_run=False,
+            env="production",
+            identifier="my-gate-1",
+            service="my-service",
+        ),
+        type=DeploymentGateDataType.DEPLOYMENT_GATE,
+    ),
+)
+
+configuration = Configuration()
+configuration.unstable_operations["create_deployment_gate"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = DeploymentGatesApi(api_client)
+    response = api_instance.create_deployment_gate(body=body)
+
+    print(response)

examples/v2/deployment-gates/CreateDeploymentGate.py

@@ -0,0 +1,41 @@
+"""
+Create deployment rule returns "OK" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.deployment_gates_api import DeploymentGatesApi
+from datadog_api_client.v2.model.create_deployment_rule_params import CreateDeploymentRuleParams
+from datadog_api_client.v2.model.create_deployment_rule_params_data import CreateDeploymentRuleParamsData
+from datadog_api_client.v2.model.create_deployment_rule_params_data_attributes import (
+    CreateDeploymentRuleParamsDataAttributes,
+)
+from datadog_api_client.v2.model.deployment_rule_data_type import DeploymentRuleDataType
+from datadog_api_client.v2.model.deployment_rule_options_faulty_deployment_detection import (
+    DeploymentRuleOptionsFaultyDeploymentDetection,
+)
+
+# there is a valid "deployment_gate" in the system
+DEPLOYMENT_GATE_DATA_ID = environ["DEPLOYMENT_GATE_DATA_ID"]
+
+body = CreateDeploymentRuleParams(
+    data=CreateDeploymentRuleParamsData(
+        attributes=CreateDeploymentRuleParamsDataAttributes(
+            dry_run=False,
+            name="My deployment rule",
+            options=DeploymentRuleOptionsFaultyDeploymentDetection(
+                excluded_resources=[],
+            ),
+            type="faulty_deployment_detection",
+        ),
+        type=DeploymentRuleDataType.DEPLOYMENT_RULE,
+    ),
+)
+
+configuration = Configuration()
+configuration.unstable_operations["create_deployment_rule"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = DeploymentGatesApi(api_client)
+    response = api_instance.create_deployment_rule(gate_id=DEPLOYMENT_GATE_DATA_ID, body=body)
+
+    print(response)

examples/v2/deployment-gates/CreateDeploymentRule.py

@@ -0,0 +1,18 @@
+"""
+Delete deployment gate returns "No Content" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.deployment_gates_api import DeploymentGatesApi
+
+# there is a valid "deployment_gate" in the system
+DEPLOYMENT_GATE_DATA_ID = environ["DEPLOYMENT_GATE_DATA_ID"]
+
+configuration = Configuration()
+configuration.unstable_operations["delete_deployment_gate"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = DeploymentGatesApi(api_client)
+    api_instance.delete_deployment_gate(
+        id=DEPLOYMENT_GATE_DATA_ID,
+    )

examples/v2/deployment-gates/DeleteDeploymentGate.py

@@ -0,0 +1,22 @@
+"""
+Delete deployment rule returns "No Content" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.deployment_gates_api import DeploymentGatesApi
+
+# there is a valid "deployment_gate" in the system
+DEPLOYMENT_GATE_DATA_ID = environ["DEPLOYMENT_GATE_DATA_ID"]
+
+# there is a valid "deployment_rule" in the system
+DEPLOYMENT_RULE_DATA_ID = environ["DEPLOYMENT_RULE_DATA_ID"]
+
+configuration = Configuration()
+configuration.unstable_operations["delete_deployment_rule"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = DeploymentGatesApi(api_client)
+    api_instance.delete_deployment_rule(
+        gate_id=DEPLOYMENT_GATE_DATA_ID,
+        id=DEPLOYMENT_RULE_DATA_ID,
+    )