Skip to content

Generate API Spec for Log Restriction Queries #2943

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

Generate API Spec for Log Restriction Queries #2943

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
647 changes: 647 additions & 0 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 @@ -319,6 +319,13 @@ datadog\_api\_client.v2.api.logs\_metrics\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.logs\_restriction\_queries\_api module
------------------------------------------------------------------

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

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

Expand Down
119 changes: 119 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 @@ -12961,6 +12961,13 @@ datadog\_api\_client.v2.model.logs\_response\_metadata\_page module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.logs\_restriction\_queries\_type module
---------------------------------------------------------------------

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

datadog\_api\_client.v2.model.logs\_sort module
-----------------------------------------------

Expand Down Expand Up @@ -17987,6 +17994,118 @@ datadog\_api\_client.v2.model.restriction\_policy\_update\_request module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.restriction\_query\_attributes module
-------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_create\_attributes module
---------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_create\_data module
---------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_create\_payload module
------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_list\_response module
-----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_response\_included\_item module
---------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_role module
-------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_role\_attribute module
------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_roles\_response module
------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_update\_attributes module
---------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_update\_data module
---------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_update\_payload module
------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_with\_relationships module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_with\_relationships\_response module
--------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_without\_relationships module
-------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.restriction\_query\_without\_relationships\_response module
-----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.retention\_filter module
------------------------------------------------------

Expand Down
22 changes: 22 additions & 0 deletions examples/v2/logs-restriction-queries/AddRoleToRestrictionQuery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
"""
Grant role to a restriction query returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi
from datadog_api_client.v2.model.relationship_to_role import RelationshipToRole
from datadog_api_client.v2.model.relationship_to_role_data import RelationshipToRoleData
from datadog_api_client.v2.model.roles_type import RolesType

body = RelationshipToRole(
data=RelationshipToRoleData(
id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
type=RolesType.ROLES,
),
)

configuration = Configuration()
configuration.unstable_operations["add_role_to_restriction_query"] = True
with ApiClient(configuration) as api_client:
api_instance = LogsRestrictionQueriesApi(api_client)
api_instance.add_role_to_restriction_query(restriction_query_id="restriction_query_id", body=body)
29 changes: 29 additions & 0 deletions examples/v2/logs-restriction-queries/AddRoleToRestrictionQuery_3894482781.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
"""
Grant role to a restriction query returns "No Content" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi
from datadog_api_client.v2.model.relationship_to_role import RelationshipToRole
from datadog_api_client.v2.model.relationship_to_role_data import RelationshipToRoleData
from datadog_api_client.v2.model.roles_type import RolesType

# there is a valid "restriction_query" in the system
RESTRICTION_QUERY_DATA_ID = environ["RESTRICTION_QUERY_DATA_ID"]

# there is a valid "role" in the system
ROLE_DATA_ID = environ["ROLE_DATA_ID"]

body = RelationshipToRole(
data=RelationshipToRoleData(
type=RolesType.ROLES,
id=ROLE_DATA_ID,
),
)

configuration = Configuration()
configuration.unstable_operations["add_role_to_restriction_query"] = True
with ApiClient(configuration) as api_client:
api_instance = LogsRestrictionQueriesApi(api_client)
api_instance.add_role_to_restriction_query(restriction_query_id=RESTRICTION_QUERY_DATA_ID, body=body)
27 changes: 27 additions & 0 deletions examples/v2/logs-restriction-queries/CreateRestrictionQuery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
"""
Create a restriction query returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi
from datadog_api_client.v2.model.logs_restriction_queries_type import LogsRestrictionQueriesType
from datadog_api_client.v2.model.restriction_query_create_attributes import RestrictionQueryCreateAttributes
from datadog_api_client.v2.model.restriction_query_create_data import RestrictionQueryCreateData
from datadog_api_client.v2.model.restriction_query_create_payload import RestrictionQueryCreatePayload

body = RestrictionQueryCreatePayload(
data=RestrictionQueryCreateData(
type=LogsRestrictionQueriesType.LOGS_RESTRICTION_QUERIES,
attributes=RestrictionQueryCreateAttributes(
restriction_query="env:sandbox",
),
),
)

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

print(response)
14 changes: 14 additions & 0 deletions examples/v2/logs-restriction-queries/DeleteRestrictionQuery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
Delete a restriction query returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi

configuration = Configuration()
configuration.unstable_operations["delete_restriction_query"] = True
with ApiClient(configuration) as api_client:
api_instance = LogsRestrictionQueriesApi(api_client)
api_instance.delete_restriction_query(
restriction_query_id="restriction_query_id",
)
18 changes: 18 additions & 0 deletions examples/v2/logs-restriction-queries/DeleteRestrictionQuery_1369314527.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
"""
Delete a restriction query returns "No Content" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi

# there is a valid "restriction_query" in the system
RESTRICTION_QUERY_DATA_ID = environ["RESTRICTION_QUERY_DATA_ID"]

configuration = Configuration()
configuration.unstable_operations["delete_restriction_query"] = True
with ApiClient(configuration) as api_client:
api_instance = LogsRestrictionQueriesApi(api_client)
api_instance.delete_restriction_query(
restriction_query_id=RESTRICTION_QUERY_DATA_ID,
)
20 changes: 20 additions & 0 deletions examples/v2/logs-restriction-queries/GetRestrictionQuery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
"""
Get a restriction query returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi

# there is a valid "restriction_query" in the system
RESTRICTION_QUERY_DATA_ID = environ["RESTRICTION_QUERY_DATA_ID"]

configuration = Configuration()
configuration.unstable_operations["get_restriction_query"] = True
with ApiClient(configuration) as api_client:
api_instance = LogsRestrictionQueriesApi(api_client)
response = api_instance.get_restriction_query(
restriction_query_id=RESTRICTION_QUERY_DATA_ID,
)

print(response)
20 changes: 20 additions & 0 deletions examples/v2/logs-restriction-queries/GetRoleRestrictionQuery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
"""
Get restriction query for a given role returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi

# there is a valid "role" in the system
ROLE_DATA_ID = environ["ROLE_DATA_ID"]

configuration = Configuration()
configuration.unstable_operations["get_role_restriction_query"] = True
with ApiClient(configuration) as api_client:
api_instance = LogsRestrictionQueriesApi(api_client)
response = api_instance.get_role_restriction_query(
role_id=ROLE_DATA_ID,
)

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

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi

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

print(response)
20 changes: 20 additions & 0 deletions examples/v2/logs-restriction-queries/ListRestrictionQueryRoles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
"""
List roles for a restriction query returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi

# there is a valid "restriction_query" in the system
RESTRICTION_QUERY_DATA_ID = environ["RESTRICTION_QUERY_DATA_ID"]

configuration = Configuration()
configuration.unstable_operations["list_restriction_query_roles"] = True
with ApiClient(configuration) as api_client:
api_instance = LogsRestrictionQueriesApi(api_client)
response = api_instance.list_restriction_query_roles(
restriction_query_id=RESTRICTION_QUERY_DATA_ID,
)

print(response)
20 changes: 20 additions & 0 deletions examples/v2/logs-restriction-queries/ListUserRestrictionQueries.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
"""
Get all restriction queries for a given user returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi

# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]

configuration = Configuration()
configuration.unstable_operations["list_user_restriction_queries"] = True
with ApiClient(configuration) as api_client:
api_instance = LogsRestrictionQueriesApi(api_client)
response = api_instance.list_user_restriction_queries(
user_id=USER_DATA_ID,
)

print(response)
22 changes: 22 additions & 0 deletions examples/v2/logs-restriction-queries/RemoveRoleFromRestrictionQuery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
"""
Revoke role from a restriction query returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi
from datadog_api_client.v2.model.relationship_to_role import RelationshipToRole
from datadog_api_client.v2.model.relationship_to_role_data import RelationshipToRoleData
from datadog_api_client.v2.model.roles_type import RolesType

body = RelationshipToRole(
data=RelationshipToRoleData(
id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
type=RolesType.ROLES,
),
)

configuration = Configuration()
configuration.unstable_operations["remove_role_from_restriction_query"] = True
with ApiClient(configuration) as api_client:
api_instance = LogsRestrictionQueriesApi(api_client)
api_instance.remove_role_from_restriction_query(restriction_query_id="restriction_query_id", body=body)
Loading
Loading