Skip to content

Commit d399cec

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Generate API Spec for Log Restriction Queries (#2943)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 27f9b78 commit d399cec

File tree

123 files changed

+6530
-14
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

123 files changed

+6530
-14
lines changed

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 1201 additions & 3 deletions
Large diffs are not rendered by default.

‎docs/datadog_api_client.v2.api.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,13 @@ datadog\_api\_client.v2.api.logs\_metrics\_api module
326326
:members:
327327
:show-inheritance:
328328

329+
datadog\_api\_client.v2.api.logs\_restriction\_queries\_api module
330+
------------------------------------------------------------------
331+
332+
.. automodule:: datadog_api_client.v2.api.logs_restriction_queries_api
333+
:members:
334+
:show-inheritance:
335+
329336
datadog\_api\_client.v2.api.metrics\_api module
330337
-----------------------------------------------
331338

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 238 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13171,6 +13171,13 @@ datadog\_api\_client.v2.model.logs\_response\_metadata\_page module
1317113171
:members:
1317213172
:show-inheritance:
1317313173

13174+
datadog\_api\_client.v2.model.logs\_restriction\_queries\_type module
13175+
---------------------------------------------------------------------
13176+
13177+
.. automodule:: datadog_api_client.v2.model.logs_restriction_queries_type
13178+
:members:
13179+
:show-inheritance:
13180+
1317413181
datadog\_api\_client.v2.model.logs\_sort module
1317513182
-----------------------------------------------
1317613183

@@ -18204,6 +18211,118 @@ datadog\_api\_client.v2.model.restriction\_policy\_update\_request module
1820418211
:members:
1820518212
:show-inheritance:
1820618213

18214+
datadog\_api\_client.v2.model.restriction\_query\_attributes module
18215+
-------------------------------------------------------------------
18216+
18217+
.. automodule:: datadog_api_client.v2.model.restriction_query_attributes
18218+
:members:
18219+
:show-inheritance:
18220+
18221+
datadog\_api\_client.v2.model.restriction\_query\_create\_attributes module
18222+
---------------------------------------------------------------------------
18223+
18224+
.. automodule:: datadog_api_client.v2.model.restriction_query_create_attributes
18225+
:members:
18226+
:show-inheritance:
18227+
18228+
datadog\_api\_client.v2.model.restriction\_query\_create\_data module
18229+
---------------------------------------------------------------------
18230+
18231+
.. automodule:: datadog_api_client.v2.model.restriction_query_create_data
18232+
:members:
18233+
:show-inheritance:
18234+
18235+
datadog\_api\_client.v2.model.restriction\_query\_create\_payload module
18236+
------------------------------------------------------------------------
18237+
18238+
.. automodule:: datadog_api_client.v2.model.restriction_query_create_payload
18239+
:members:
18240+
:show-inheritance:
18241+
18242+
datadog\_api\_client.v2.model.restriction\_query\_list\_response module
18243+
-----------------------------------------------------------------------
18244+
18245+
.. automodule:: datadog_api_client.v2.model.restriction_query_list_response
18246+
:members:
18247+
:show-inheritance:
18248+
18249+
datadog\_api\_client.v2.model.restriction\_query\_response\_included\_item module
18250+
---------------------------------------------------------------------------------
18251+
18252+
.. automodule:: datadog_api_client.v2.model.restriction_query_response_included_item
18253+
:members:
18254+
:show-inheritance:
18255+
18256+
datadog\_api\_client.v2.model.restriction\_query\_role module
18257+
-------------------------------------------------------------
18258+
18259+
.. automodule:: datadog_api_client.v2.model.restriction_query_role
18260+
:members:
18261+
:show-inheritance:
18262+
18263+
datadog\_api\_client.v2.model.restriction\_query\_role\_attribute module
18264+
------------------------------------------------------------------------
18265+
18266+
.. automodule:: datadog_api_client.v2.model.restriction_query_role_attribute
18267+
:members:
18268+
:show-inheritance:
18269+
18270+
datadog\_api\_client.v2.model.restriction\_query\_roles\_response module
18271+
------------------------------------------------------------------------
18272+
18273+
.. automodule:: datadog_api_client.v2.model.restriction_query_roles_response
18274+
:members:
18275+
:show-inheritance:
18276+
18277+
datadog\_api\_client.v2.model.restriction\_query\_update\_attributes module
18278+
---------------------------------------------------------------------------
18279+
18280+
.. automodule:: datadog_api_client.v2.model.restriction_query_update_attributes
18281+
:members:
18282+
:show-inheritance:
18283+
18284+
datadog\_api\_client.v2.model.restriction\_query\_update\_data module
18285+
---------------------------------------------------------------------
18286+
18287+
.. automodule:: datadog_api_client.v2.model.restriction_query_update_data
18288+
:members:
18289+
:show-inheritance:
18290+
18291+
datadog\_api\_client.v2.model.restriction\_query\_update\_payload module
18292+
------------------------------------------------------------------------
18293+
18294+
.. automodule:: datadog_api_client.v2.model.restriction_query_update_payload
18295+
:members:
18296+
:show-inheritance:
18297+
18298+
datadog\_api\_client.v2.model.restriction\_query\_with\_relationships module
18299+
----------------------------------------------------------------------------
18300+
18301+
.. automodule:: datadog_api_client.v2.model.restriction_query_with_relationships
18302+
:members:
18303+
:show-inheritance:
18304+
18305+
datadog\_api\_client.v2.model.restriction\_query\_with\_relationships\_response module
18306+
--------------------------------------------------------------------------------------
18307+
18308+
.. automodule:: datadog_api_client.v2.model.restriction_query_with_relationships_response
18309+
:members:
18310+
:show-inheritance:
18311+
18312+
datadog\_api\_client.v2.model.restriction\_query\_without\_relationships module
18313+
-------------------------------------------------------------------------------
18314+
18315+
.. automodule:: datadog_api_client.v2.model.restriction_query_without_relationships
18316+
:members:
18317+
:show-inheritance:
18318+
18319+
datadog\_api\_client.v2.model.restriction\_query\_without\_relationships\_response module
18320+
-----------------------------------------------------------------------------------------
18321+
18322+
.. automodule:: datadog_api_client.v2.model.restriction_query_without_relationships_response
18323+
:members:
18324+
:show-inheritance:
18325+
1820718326
datadog\_api\_client.v2.model.retention\_filter module
1820818327
------------------------------------------------------
1820918328

@@ -22922,6 +23041,104 @@ datadog\_api\_client.v2.model.team\_create\_request module
2292223041
:members:
2292323042
:show-inheritance:
2292423043

23044+
datadog\_api\_client.v2.model.team\_hierarchy\_link module
23045+
----------------------------------------------------------
23046+
23047+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_link
23048+
:members:
23049+
:show-inheritance:
23050+
23051+
datadog\_api\_client.v2.model.team\_hierarchy\_link\_attributes module
23052+
----------------------------------------------------------------------
23053+
23054+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_link_attributes
23055+
:members:
23056+
:show-inheritance:
23057+
23058+
datadog\_api\_client.v2.model.team\_hierarchy\_link\_create module
23059+
------------------------------------------------------------------
23060+
23061+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_link_create
23062+
:members:
23063+
:show-inheritance:
23064+
23065+
datadog\_api\_client.v2.model.team\_hierarchy\_link\_create\_relationships module
23066+
---------------------------------------------------------------------------------
23067+
23068+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_link_create_relationships
23069+
:members:
23070+
:show-inheritance:
23071+
23072+
datadog\_api\_client.v2.model.team\_hierarchy\_link\_create\_request module
23073+
---------------------------------------------------------------------------
23074+
23075+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_link_create_request
23076+
:members:
23077+
:show-inheritance:
23078+
23079+
datadog\_api\_client.v2.model.team\_hierarchy\_link\_create\_team module
23080+
------------------------------------------------------------------------
23081+
23082+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_link_create_team
23083+
:members:
23084+
:show-inheritance:
23085+
23086+
datadog\_api\_client.v2.model.team\_hierarchy\_link\_create\_team\_relationship module
23087+
--------------------------------------------------------------------------------------
23088+
23089+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_link_create_team_relationship
23090+
:members:
23091+
:show-inheritance:
23092+
23093+
datadog\_api\_client.v2.model.team\_hierarchy\_link\_relationships module
23094+
-------------------------------------------------------------------------
23095+
23096+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_link_relationships
23097+
:members:
23098+
:show-inheritance:
23099+
23100+
datadog\_api\_client.v2.model.team\_hierarchy\_link\_response module
23101+
--------------------------------------------------------------------
23102+
23103+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_link_response
23104+
:members:
23105+
:show-inheritance:
23106+
23107+
datadog\_api\_client.v2.model.team\_hierarchy\_link\_team module
23108+
----------------------------------------------------------------
23109+
23110+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_link_team
23111+
:members:
23112+
:show-inheritance:
23113+
23114+
datadog\_api\_client.v2.model.team\_hierarchy\_link\_team\_attributes module
23115+
----------------------------------------------------------------------------
23116+
23117+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_link_team_attributes
23118+
:members:
23119+
:show-inheritance:
23120+
23121+
datadog\_api\_client.v2.model.team\_hierarchy\_link\_team\_relationship module
23122+
------------------------------------------------------------------------------
23123+
23124+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_link_team_relationship
23125+
:members:
23126+
:show-inheritance:
23127+
23128+
datadog\_api\_client.v2.model.team\_hierarchy\_link\_type module
23129+
----------------------------------------------------------------
23130+
23131+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_link_type
23132+
:members:
23133+
:show-inheritance:
23134+
23135+
datadog\_api\_client.v2.model.team\_hierarchy\_links\_response module
23136+
---------------------------------------------------------------------
23137+
23138+
.. automodule:: datadog_api_client.v2.model.team_hierarchy_links_response
23139+
:members:
23140+
:show-inheritance:
23141+
2292523142
datadog\_api\_client.v2.model.team\_included module
2292623143
---------------------------------------------------
2292723144

@@ -23398,6 +23615,27 @@ datadog\_api\_client.v2.model.teams\_field module
2339823615
:members:
2339923616
:show-inheritance:
2340023617

23618+
datadog\_api\_client.v2.model.teams\_hierarchy\_links\_response\_links module
23619+
-----------------------------------------------------------------------------
23620+
23621+
.. automodule:: datadog_api_client.v2.model.teams_hierarchy_links_response_links
23622+
:members:
23623+
:show-inheritance:
23624+
23625+
datadog\_api\_client.v2.model.teams\_hierarchy\_links\_response\_meta module
23626+
----------------------------------------------------------------------------
23627+
23628+
.. automodule:: datadog_api_client.v2.model.teams_hierarchy_links_response_meta
23629+
:members:
23630+
:show-inheritance:
23631+
23632+
datadog\_api\_client.v2.model.teams\_hierarchy\_links\_response\_meta\_page module
23633+
----------------------------------------------------------------------------------
23634+
23635+
.. automodule:: datadog_api_client.v2.model.teams_hierarchy_links_response_meta_page
23636+
:members:
23637+
:show-inheritance:
23638+
2340123639
datadog\_api\_client.v2.model.teams\_response module
2340223640
----------------------------------------------------
2340323641

‎examples/v2/logs-restriction-queries/AddRoleToRestrictionQuery.py‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
"""
2+
Grant role to a restriction query returns "OK" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi
8+
from datadog_api_client.v2.model.relationship_to_role import RelationshipToRole
9+
from datadog_api_client.v2.model.relationship_to_role_data import RelationshipToRoleData
10+
from datadog_api_client.v2.model.roles_type import RolesType
11+
12+
# there is a valid "restriction_query" in the system
13+
RESTRICTION_QUERY_DATA_ID = environ["RESTRICTION_QUERY_DATA_ID"]
14+
15+
# there is a valid "role" in the system
16+
ROLE_DATA_ID = environ["ROLE_DATA_ID"]
17+
18+
body = RelationshipToRole(
19+
data=RelationshipToRoleData(
20+
id=ROLE_DATA_ID,
21+
type=RolesType.ROLES,
22+
),
23+
)
24+
25+
configuration = Configuration()
26+
configuration.unstable_operations["add_role_to_restriction_query"] = True
27+
with ApiClient(configuration) as api_client:
28+
api_instance = LogsRestrictionQueriesApi(api_client)
29+
api_instance.add_role_to_restriction_query(restriction_query_id=RESTRICTION_QUERY_DATA_ID, body=body)

‎examples/v2/logs-restriction-queries/CreateRestrictionQuery.py‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
"""
2+
Create a restriction query returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi
7+
from datadog_api_client.v2.model.logs_restriction_queries_type import LogsRestrictionQueriesType
8+
from datadog_api_client.v2.model.restriction_query_create_attributes import RestrictionQueryCreateAttributes
9+
from datadog_api_client.v2.model.restriction_query_create_data import RestrictionQueryCreateData
10+
from datadog_api_client.v2.model.restriction_query_create_payload import RestrictionQueryCreatePayload
11+
12+
body = RestrictionQueryCreatePayload(
13+
data=RestrictionQueryCreateData(
14+
attributes=RestrictionQueryCreateAttributes(
15+
restriction_query="env:sandbox",
16+
),
17+
type=LogsRestrictionQueriesType.LOGS_RESTRICTION_QUERIES,
18+
),
19+
)
20+
21+
configuration = Configuration()
22+
configuration.unstable_operations["create_restriction_query"] = True
23+
with ApiClient(configuration) as api_client:
24+
api_instance = LogsRestrictionQueriesApi(api_client)
25+
response = api_instance.create_restriction_query(body=body)
26+
27+
print(response)

‎examples/v2/logs-restriction-queries/DeleteRestrictionQuery.py‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
"""
2+
Delete a restriction query returns "OK" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi
8+
9+
# there is a valid "restriction_query" in the system
10+
RESTRICTION_QUERY_DATA_ID = environ["RESTRICTION_QUERY_DATA_ID"]
11+
12+
configuration = Configuration()
13+
configuration.unstable_operations["delete_restriction_query"] = True
14+
with ApiClient(configuration) as api_client:
15+
api_instance = LogsRestrictionQueriesApi(api_client)
16+
api_instance.delete_restriction_query(
17+
restriction_query_id=RESTRICTION_QUERY_DATA_ID,
18+
)

‎examples/v2/logs-restriction-queries/GetRestrictionQuery.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
"""
2+
Get a restriction query returns "OK" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi
8+
9+
# there is a valid "restriction_query" in the system
10+
RESTRICTION_QUERY_DATA_ID = environ["RESTRICTION_QUERY_DATA_ID"]
11+
12+
configuration = Configuration()
13+
configuration.unstable_operations["get_restriction_query"] = True
14+
with ApiClient(configuration) as api_client:
15+
api_instance = LogsRestrictionQueriesApi(api_client)
16+
response = api_instance.get_restriction_query(
17+
restriction_query_id=RESTRICTION_QUERY_DATA_ID,
18+
)
19+
20+
print(response)

‎examples/v2/logs-restriction-queries/GetRoleRestrictionQuery.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
"""
2+
Get restriction query for a given role returns "OK" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi
8+
9+
# there is a valid "role" in the system
10+
ROLE_DATA_ID = environ["ROLE_DATA_ID"]
11+
12+
configuration = Configuration()
13+
configuration.unstable_operations["get_role_restriction_query"] = True
14+
with ApiClient(configuration) as api_client:
15+
api_instance = LogsRestrictionQueriesApi(api_client)
16+
response = api_instance.get_role_restriction_query(
17+
role_id=ROLE_DATA_ID,
18+
)
19+
20+
print(response)

0 commit comments

Comments
 (0)