Skip to content

Add OpenAPI documentation for admin-front-door service endpoints #3147

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
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add OpenAPI documentation for admin-front-door service endpoints #3147

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
695 changes: 695 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 14 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 @@ -438,6 +438,13 @@ datadog\_api\_client.v2.api.organizations\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.policy\_management\_api module
----------------------------------------------------------

.. automodule:: datadog_api_client.v2.api.policy_management_api
:members:
:show-inheritance:

datadog\_api\_client.v2.api.powerpack\_api module
-------------------------------------------------

Expand Down Expand Up @@ -606,6 +613,13 @@ datadog\_api\_client.v2.api.synthetics\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.tag\_policies\_api module
-----------------------------------------------------

.. automodule:: datadog_api_client.v2.api.tag_policies_api
:members:
:show-inheritance:

datadog\_api\_client.v2.api.teams\_api module
---------------------------------------------

Expand Down
133 changes: 133 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 @@ -19478,6 +19478,34 @@ datadog\_api\_client.v2.model.permissions\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.policy\_result\_attributes\_response module
-------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.policy_result_attributes_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.policy\_result\_data\_response module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.policy_result_data_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.policy\_result\_response module
-------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.policy_result_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.policy\_result\_type module
---------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.policy_result_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.postmortem\_attachment\_request module
--------------------------------------------------------------------

Expand Down Expand Up @@ -26667,6 +26695,111 @@ datadog\_api\_client.v2.model.table\_row\_resource\_data\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policies\_response module
------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policies_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_attributes\_request module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_attributes_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_attributes\_response module
----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_attributes_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_attributes\_update\_request module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_attributes_update_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_create\_request module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_create_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_data\_request module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_data_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_data\_response module
----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_data_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_data\_update\_request module
-----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_data_update_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_response module
----------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_score\_attributes\_response module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_score_attributes_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_score\_data\_response module
-----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_score_data_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_score\_response module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_score_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_score\_type module
-------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_score_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_type module
------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tag\_policy\_update\_request module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.tag_policy_update_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.tags\_event\_attribute module
-----------------------------------------------------------

Expand Down
16 changes: 16 additions & 0 deletions examples/v2/policy-management/EvaluatePolicyResult.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Evaluate policy result returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.policy_management_api import PolicyManagementApi

configuration = Configuration()
configuration.unstable_operations["evaluate_policy_result"] = True
with ApiClient(configuration) as api_client:
api_instance = PolicyManagementApi(api_client)
response = api_instance.evaluate_policy_result(
policy_type="SAML",
)

print(response)
37 changes: 37 additions & 0 deletions examples/v2/tag-policies/CreateTagPolicy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
"""
Create a tag policy returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.tag_policies_api import TagPoliciesApi
from datadog_api_client.v2.model.tag_policy_attributes_request import TagPolicyAttributesRequest
from datadog_api_client.v2.model.tag_policy_create_request import TagPolicyCreateRequest
from datadog_api_client.v2.model.tag_policy_data_request import TagPolicyDataRequest
from datadog_api_client.v2.model.tag_policy_type import TagPolicyType

body = TagPolicyCreateRequest(
data=TagPolicyDataRequest(
attributes=TagPolicyAttributesRequest(
enabled=True,
negated=False,
policy_name="production-tags-policy",
required=True,
scope="env",
source="logs",
tag_key="service",
tag_value_patterns=[
"api",
"web",
],
),
type=TagPolicyType.TAG_POLICY,
),
)

configuration = Configuration()
configuration.unstable_operations["create_tag_policy"] = True
with ApiClient(configuration) as api_client:
api_instance = TagPoliciesApi(api_client)
response = api_instance.create_tag_policy(body=body)

print(response)
14 changes: 14 additions & 0 deletions examples/v2/tag-policies/DeleteTagPolicy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
Delete a tag policy returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.tag_policies_api import TagPoliciesApi

configuration = Configuration()
configuration.unstable_operations["delete_tag_policy"] = True
with ApiClient(configuration) as api_client:
api_instance = TagPoliciesApi(api_client)
api_instance.delete_tag_policy(
policy_id="123",
)
16 changes: 16 additions & 0 deletions examples/v2/tag-policies/GetTagPolicy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Get a tag policy returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.tag_policies_api import TagPoliciesApi

configuration = Configuration()
configuration.unstable_operations["get_tag_policy"] = True
with ApiClient(configuration) as api_client:
api_instance = TagPoliciesApi(api_client)
response = api_instance.get_tag_policy(
policy_id="123",
)

print(response)
16 changes: 16 additions & 0 deletions examples/v2/tag-policies/GetTagPolicyScore.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Get tag policy score returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.tag_policies_api import TagPoliciesApi

configuration = Configuration()
configuration.unstable_operations["get_tag_policy_score"] = True
with ApiClient(configuration) as api_client:
api_instance = TagPoliciesApi(api_client)
response = api_instance.get_tag_policy_score(
policy_id="123",
)

print(response)
14 changes: 14 additions & 0 deletions examples/v2/tag-policies/ListTagPolicies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
List tag policies returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.tag_policies_api import TagPoliciesApi

configuration = Configuration()
configuration.unstable_operations["list_tag_policies"] = True
with ApiClient(configuration) as api_client:
api_instance = TagPoliciesApi(api_client)
response = api_instance.list_tag_policies()

print(response)
37 changes: 37 additions & 0 deletions examples/v2/tag-policies/UpdateTagPolicy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
"""
Update a tag policy returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.tag_policies_api import TagPoliciesApi
from datadog_api_client.v2.model.tag_policy_attributes_update_request import TagPolicyAttributesUpdateRequest
from datadog_api_client.v2.model.tag_policy_data_update_request import TagPolicyDataUpdateRequest
from datadog_api_client.v2.model.tag_policy_type import TagPolicyType
from datadog_api_client.v2.model.tag_policy_update_request import TagPolicyUpdateRequest

body = TagPolicyUpdateRequest(
data=TagPolicyDataUpdateRequest(
attributes=TagPolicyAttributesUpdateRequest(
enabled=True,
negated=False,
policy_name="production-tags-policy",
required=True,
scope="env",
source="logs",
tag_key="service",
tag_value_patterns=[
"api",
"web",
],
),
type=TagPolicyType.TAG_POLICY,
),
)

configuration = Configuration()
configuration.unstable_operations["update_tag_policy"] = True
with ApiClient(configuration) as api_client:
api_instance = TagPoliciesApi(api_client)
response = api_instance.update_tag_policy(policy_id="123", body=body)

print(response)
7 changes: 7 additions & 0 deletions src/datadog_api_client/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,7 @@ def __init__(
"v2.validate_existing_monitor_user_template": False,
"v2.validate_monitor_user_template": False,
"v2.list_role_templates": False,
"v2.evaluate_policy_result": False,
"v2.create_connection": False,
"v2.delete_connection": False,
"v2.get_account_facet_info": False,
Expand Down Expand Up @@ -422,6 +423,12 @@ def __init__(
"v2.list_custom_rule_revisions": False,
"v2.revert_custom_rule_revision": False,
"v2.update_custom_ruleset": False,
"v2.create_tag_policy": False,
"v2.delete_tag_policy": False,
"v2.get_tag_policy": False,
"v2.get_tag_policy_score": False,
"v2.list_tag_policies": False,
"v2.update_tag_policy": False,
"v2.add_member_team": False,
"v2.list_member_teams": False,
"v2.remove_member_team": False,
Expand Down
Loading