Skip to content

Add api specs for deployment gates #2893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add api specs for deployment gates #2893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
870 changes: 868 additions & 2 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions docs/datadog_api_client.v2.api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------------------------------------------

Expand Down
217 changes: 217 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4967,6 +4967,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
----------------------------------------------------------------------------------

Expand Down Expand Up @@ -6458,6 +6500,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
---------------------------------------------------------

Expand All @@ -6479,6 +6563,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
------------------------------------------------------

Expand Down Expand Up @@ -9615,6 +9769,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
-------------------------------------------------------

Expand Down Expand Up @@ -22929,6 +23104,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
----------------------------------------------------------------

Expand Down
32 changes: 32 additions & 0 deletions examples/v2/deployment-gates/CreateDeploymentGate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
41 changes: 41 additions & 0 deletions examples/v2/deployment-gates/CreateDeploymentRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
18 changes: 18 additions & 0 deletions examples/v2/deployment-gates/DeleteDeploymentGate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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,
)
22 changes: 22 additions & 0 deletions examples/v2/deployment-gates/DeleteDeploymentRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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,
)
Loading