Skip to content

Commit f118dd9

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add Team Connection API Documentation (#2936)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 01a3b23 commit f118dd9

32 files changed

+1885
-0
lines changed

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

Lines changed: 369 additions & 0 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
@@ -543,6 +543,13 @@ datadog\_api\_client.v2.api.synthetics\_api module
543543
:members:
544544
:show-inheritance:
545545

546+
datadog\_api\_client.v2.api.team\_connections\_api module
547+
---------------------------------------------------------
548+
549+
.. automodule:: datadog_api_client.v2.api.team_connections_api
550+
:members:
551+
:show-inheritance:
552+
546553
datadog\_api\_client.v2.api.teams\_api module
547554
---------------------------------------------
548555

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4484,6 +4484,27 @@ datadog\_api\_client.v2.model.confluent\_resources\_response module
44844484
:members:
44854485
:show-inheritance:
44864486

4487+
datadog\_api\_client.v2.model.connected\_team\_ref module
4488+
---------------------------------------------------------
4489+
4490+
.. automodule:: datadog_api_client.v2.model.connected_team_ref
4491+
:members:
4492+
:show-inheritance:
4493+
4494+
datadog\_api\_client.v2.model.connected\_team\_ref\_data module
4495+
---------------------------------------------------------------
4496+
4497+
.. automodule:: datadog_api_client.v2.model.connected_team_ref_data
4498+
:members:
4499+
:show-inheritance:
4500+
4501+
datadog\_api\_client.v2.model.connected\_team\_ref\_data\_type module
4502+
---------------------------------------------------------------------
4503+
4504+
.. automodule:: datadog_api_client.v2.model.connected_team_ref_data_type
4505+
:members:
4506+
:show-inheritance:
4507+
44874508
datadog\_api\_client.v2.model.connection module
44884509
-----------------------------------------------
44894510

@@ -4512,6 +4533,20 @@ datadog\_api\_client.v2.model.connection\_group module
45124533
:members:
45134534
:show-inheritance:
45144535

4536+
datadog\_api\_client.v2.model.connections\_page\_pagination module
4537+
------------------------------------------------------------------
4538+
4539+
.. automodule:: datadog_api_client.v2.model.connections_page_pagination
4540+
:members:
4541+
:show-inheritance:
4542+
4543+
datadog\_api\_client.v2.model.connections\_response\_meta module
4544+
----------------------------------------------------------------
4545+
4546+
.. automodule:: datadog_api_client.v2.model.connections_response_meta
4547+
:members:
4548+
:show-inheritance:
4549+
45154550
datadog\_api\_client.v2.model.container module
45164551
----------------------------------------------
45174552

@@ -22628,6 +22663,69 @@ datadog\_api\_client.v2.model.team\_attributes module
2262822663
:members:
2262922664
:show-inheritance:
2263022665

22666+
datadog\_api\_client.v2.model.team\_connection module
22667+
-----------------------------------------------------
22668+
22669+
.. automodule:: datadog_api_client.v2.model.team_connection
22670+
:members:
22671+
:show-inheritance:
22672+
22673+
datadog\_api\_client.v2.model.team\_connection\_attributes module
22674+
-----------------------------------------------------------------
22675+
22676+
.. automodule:: datadog_api_client.v2.model.team_connection_attributes
22677+
:members:
22678+
:show-inheritance:
22679+
22680+
datadog\_api\_client.v2.model.team\_connection\_create\_data module
22681+
-------------------------------------------------------------------
22682+
22683+
.. automodule:: datadog_api_client.v2.model.team_connection_create_data
22684+
:members:
22685+
:show-inheritance:
22686+
22687+
datadog\_api\_client.v2.model.team\_connection\_create\_request module
22688+
----------------------------------------------------------------------
22689+
22690+
.. automodule:: datadog_api_client.v2.model.team_connection_create_request
22691+
:members:
22692+
:show-inheritance:
22693+
22694+
datadog\_api\_client.v2.model.team\_connection\_delete\_request module
22695+
----------------------------------------------------------------------
22696+
22697+
.. automodule:: datadog_api_client.v2.model.team_connection_delete_request
22698+
:members:
22699+
:show-inheritance:
22700+
22701+
datadog\_api\_client.v2.model.team\_connection\_delete\_request\_data\_item module
22702+
----------------------------------------------------------------------------------
22703+
22704+
.. automodule:: datadog_api_client.v2.model.team_connection_delete_request_data_item
22705+
:members:
22706+
:show-inheritance:
22707+
22708+
datadog\_api\_client.v2.model.team\_connection\_relationships module
22709+
--------------------------------------------------------------------
22710+
22711+
.. automodule:: datadog_api_client.v2.model.team_connection_relationships
22712+
:members:
22713+
:show-inheritance:
22714+
22715+
datadog\_api\_client.v2.model.team\_connection\_type module
22716+
-----------------------------------------------------------
22717+
22718+
.. automodule:: datadog_api_client.v2.model.team_connection_type
22719+
:members:
22720+
:show-inheritance:
22721+
22722+
datadog\_api\_client.v2.model.team\_connections\_response module
22723+
----------------------------------------------------------------
22724+
22725+
.. automodule:: datadog_api_client.v2.model.team_connections_response
22726+
:members:
22727+
:show-inheritance:
22728+
2263122729
datadog\_api\_client.v2.model.team\_create module
2263222730
-------------------------------------------------
2263322731

@@ -22866,6 +22964,27 @@ datadog\_api\_client.v2.model.team\_permission\_settings\_response module
2286622964
:members:
2286722965
:show-inheritance:
2286822966

22967+
datadog\_api\_client.v2.model.team\_ref module
22968+
----------------------------------------------
22969+
22970+
.. automodule:: datadog_api_client.v2.model.team_ref
22971+
:members:
22972+
:show-inheritance:
22973+
22974+
datadog\_api\_client.v2.model.team\_ref\_data module
22975+
----------------------------------------------------
22976+
22977+
.. automodule:: datadog_api_client.v2.model.team_ref_data
22978+
:members:
22979+
:show-inheritance:
22980+
22981+
datadog\_api\_client.v2.model.team\_ref\_data\_type module
22982+
----------------------------------------------------------
22983+
22984+
.. automodule:: datadog_api_client.v2.model.team_ref_data_type
22985+
:members:
22986+
:show-inheritance:
22987+
2286922988
datadog\_api\_client.v2.model.team\_reference module
2287022989
----------------------------------------------------
2287122990

‎examples/v2/team-connections/CreateTeamConnections.py‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
"""
2+
Create team connections returns "Created" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.team_connections_api import TeamConnectionsApi
8+
from datadog_api_client.v2.model.connected_team_ref import ConnectedTeamRef
9+
from datadog_api_client.v2.model.connected_team_ref_data import ConnectedTeamRefData
10+
from datadog_api_client.v2.model.connected_team_ref_data_type import ConnectedTeamRefDataType
11+
from datadog_api_client.v2.model.team_connection_attributes import TeamConnectionAttributes
12+
from datadog_api_client.v2.model.team_connection_create_data import TeamConnectionCreateData
13+
from datadog_api_client.v2.model.team_connection_create_request import TeamConnectionCreateRequest
14+
from datadog_api_client.v2.model.team_connection_relationships import TeamConnectionRelationships
15+
from datadog_api_client.v2.model.team_connection_type import TeamConnectionType
16+
from datadog_api_client.v2.model.team_ref import TeamRef
17+
from datadog_api_client.v2.model.team_ref_data import TeamRefData
18+
from datadog_api_client.v2.model.team_ref_data_type import TeamRefDataType
19+
20+
# there is a valid "dd_team" in the system
21+
DD_TEAM_DATA_ID = environ["DD_TEAM_DATA_ID"]
22+
23+
body = TeamConnectionCreateRequest(
24+
data=[
25+
TeamConnectionCreateData(
26+
type=TeamConnectionType.TEAM_CONNECTION,
27+
attributes=TeamConnectionAttributes(
28+
source="github",
29+
managed_by="datadog",
30+
),
31+
relationships=TeamConnectionRelationships(
32+
team=TeamRef(
33+
data=TeamRefData(
34+
id=DD_TEAM_DATA_ID,
35+
type=TeamRefDataType.TEAM,
36+
),
37+
),
38+
connected_team=ConnectedTeamRef(
39+
data=ConnectedTeamRefData(
40+
id="@MyGitHubAccount/my-team-name",
41+
type=ConnectedTeamRefDataType.GITHUB_TEAM,
42+
),
43+
),
44+
),
45+
),
46+
],
47+
)
48+
49+
configuration = Configuration()
50+
configuration.unstable_operations["create_team_connections"] = True
51+
with ApiClient(configuration) as api_client:
52+
api_instance = TeamConnectionsApi(api_client)
53+
response = api_instance.create_team_connections(body=body)
54+
55+
print(response)

‎examples/v2/team-connections/DeleteTeamConnections.py‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
"""
2+
Delete team connections returns "No Content" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.team_connections_api import TeamConnectionsApi
7+
from datadog_api_client.v2.model.team_connection_delete_request import TeamConnectionDeleteRequest
8+
from datadog_api_client.v2.model.team_connection_delete_request_data_item import TeamConnectionDeleteRequestDataItem
9+
from datadog_api_client.v2.model.team_connection_type import TeamConnectionType
10+
11+
body = TeamConnectionDeleteRequest(
12+
data=[
13+
TeamConnectionDeleteRequestDataItem(
14+
id="12345678-1234-5678-9abc-123456789012",
15+
type=TeamConnectionType.TEAM_CONNECTION,
16+
),
17+
],
18+
)
19+
20+
configuration = Configuration()
21+
configuration.unstable_operations["delete_team_connections"] = True
22+
with ApiClient(configuration) as api_client:
23+
api_instance = TeamConnectionsApi(api_client)
24+
api_instance.delete_team_connections(body=body)

‎examples/v2/team-connections/ListTeamConnections.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""
2+
List team connections returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.team_connections_api import TeamConnectionsApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["list_team_connections"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = TeamConnectionsApi(api_client)
12+
response = api_instance.list_team_connections()
13+
14+
print(response)

‎examples/v2/team-connections/ListTeamConnections_1473516764.py‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
"""
2+
List team connections with filters returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.team_connections_api import TeamConnectionsApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["list_team_connections"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = TeamConnectionsApi(api_client)
12+
response = api_instance.list_team_connections(
13+
page_size=10,
14+
filter_sources=[
15+
"github",
16+
],
17+
)
18+
19+
print(response)

‎examples/v2/team-connections/ListTeamConnections_2418873869.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""
2+
List team connections returns "OK" response with pagination
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.team_connections_api import TeamConnectionsApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["list_team_connections"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = TeamConnectionsApi(api_client)
12+
items = api_instance.list_team_connections_with_pagination()
13+
for item in items:
14+
print(item)

‎src/datadog_api_client/configuration.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,9 @@ def __init__(
375375
"v2.list_member_teams": False,
376376
"v2.remove_member_team": False,
377377
"v2.sync_teams": False,
378+
"v2.create_team_connections": False,
379+
"v2.delete_team_connections": False,
380+
"v2.list_team_connections": False,
378381
"v2.create_incident_team": False,
379382
"v2.delete_incident_team": False,
380383
"v2.get_incident_team": False,

0 commit comments

Comments
 (0)