Skip to content

Commit 262a675

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add additional UpdateTeamMembership scenarios (#3182)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 072e71e commit 262a675

11 files changed

+340
-16
lines changed

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101462,7 +101462,13 @@ paths:
101462101462
application/json:
101463101463
schema:
101464101464
$ref: '#/components/schemas/UserTeamResponse'
101465-
description: Represents a user's association to a team
101465+
description: OK
101466+
'400':
101467+
content:
101468+
application/json:
101469+
schema:
101470+
$ref: '#/components/schemas/APIErrorResponse'
101471+
description: API error response.
101466101472
'403':
101467101473
$ref: '#/components/responses/ForbiddenResponse'
101468101474
'404':

‎examples/v2/teams/UpdateTeamMembership.py‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
"""
2-
Update a user's membership attributes on a team returns "Represents a user's association to a team" response
2+
Update a user's membership attributes on a team returns "OK" response
33
"""
44

5+
from os import environ
56
from datadog_api_client import ApiClient, Configuration
67
from datadog_api_client.v2.api.teams_api import TeamsApi
78
from datadog_api_client.v2.model.user_team_attributes import UserTeamAttributes
@@ -10,6 +11,12 @@
1011
from datadog_api_client.v2.model.user_team_update import UserTeamUpdate
1112
from datadog_api_client.v2.model.user_team_update_request import UserTeamUpdateRequest
1213

14+
# there is a valid "dd_team" in the system
15+
DD_TEAM_DATA_ID = environ["DD_TEAM_DATA_ID"]
16+
17+
# there is a valid "user" in the system
18+
USER_DATA_ID = environ["USER_DATA_ID"]
19+
1320
body = UserTeamUpdateRequest(
1421
data=UserTeamUpdate(
1522
attributes=UserTeamAttributes(
@@ -22,6 +29,6 @@
2229
configuration = Configuration()
2330
with ApiClient(configuration) as api_client:
2431
api_instance = TeamsApi(api_client)
25-
response = api_instance.update_team_membership(team_id="team_id", user_id="user_id", body=body)
32+
response = api_instance.update_team_membership(team_id=DD_TEAM_DATA_ID, user_id=USER_DATA_ID, body=body)
2633

2734
print(response)

‎tests/v2/cassettes/test_scenarios/test_update_a_users_membership_attributes_on_a_team_returns_api_error_response_response.frozen‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2026-02-12T14:57:57.281Z

‎tests/v2/cassettes/test_scenarios/test_update_a_users_membership_attributes_on_a_team_returns_api_error_response_response.yaml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
interactions:
2+
- request:
3+
body: '{"data":{"attributes":{"handle":"test-handle-d1ea4282abe3f68d","name":"test-name-d1ea4282abe3f68d"},"type":"team"}}'
4+
headers:
5+
accept:
6+
- application/json
7+
content-type:
8+
- application/json
9+
method: POST
10+
uri: https://api.datadoghq.com/api/v2/team
11+
response:
12+
body:
13+
string: '{"data":{"id":"587b5f1a-b8ef-42b7-a99a-746cb80422a4","type":"team","attributes":{"avatar":null,"banner":6,"created_at":"2026-02-12T14:57:57.783497+00:00","description":null,"handle":"test-handle-d1ea4282abe3f68d","hidden_modules":null,"is_managed":false,"link_count":0,"modified_at":"2026-02-12T14:57:57.783497+00:00","name":"test-name-d1ea4282abe3f68d","summary":null,"user_count":0,"visible_modules":null},"relationships":{"team_links":{"data":[],"links":{"related":"/api/v2/team/587b5f1a-b8ef-42b7-a99a-746cb80422a4/links"}},"user_team_permissions":{"data":null,"links":{"related":"/api/v2/team/587b5f1a-b8ef-42b7-a99a-746cb80422a4/permission-settings"}}}}}'
14+
headers:
15+
content-type:
16+
- application/vnd.api+json
17+
status:
18+
code: 201
19+
message: Created
20+
- request:
21+
body: '{"data":{"attributes":{"role":"admin"},"type":"team_memberships"}}'
22+
headers:
23+
accept:
24+
- application/json
25+
content-type:
26+
- application/json
27+
method: PATCH
28+
uri: https://api.datadoghq.com/api/v2/team/587b5f1a-b8ef-42b7-a99a-746cb80422a4/memberships/00000000-0000-dead-beef-000000000000
29+
response:
30+
body:
31+
string: '{"errors":["User for ID 00000000-0000-dead-beef-000000000000 not found"]}'
32+
headers:
33+
content-type:
34+
- application/json
35+
status:
36+
code: 404
37+
message: Not Found
38+
- request:
39+
body: null
40+
headers:
41+
accept:
42+
- '*/*'
43+
method: DELETE
44+
uri: https://api.datadoghq.com/api/v2/team/587b5f1a-b8ef-42b7-a99a-746cb80422a4
45+
response:
46+
body:
47+
string: ''
48+
headers: {}
49+
status:
50+
code: 204
51+
message: No Content
52+
version: 1

‎tests/v2/cassettes/test_scenarios/test_update_a_users_membership_attributes_on_a_team_returns_ok_response.frozen‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2026-02-12T14:59:46.756Z

‎tests/v2/cassettes/test_scenarios/test_update_a_users_membership_attributes_on_a_team_returns_ok_response.yaml‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
interactions:
2+
- request:
3+
body: '{"data":{"attributes":{"handle":"test-handle-ae403c8f160ec46f","name":"test-name-ae403c8f160ec46f"},"type":"team"}}'
4+
headers:
5+
accept:
6+
- application/json
7+
content-type:
8+
- application/json
9+
method: POST
10+
uri: https://api.datadoghq.com/api/v2/team
11+
response:
12+
body:
13+
string: '{"data":{"id":"38c0d1d3-69c0-4452-95a0-0115b22f2607","type":"team","attributes":{"avatar":null,"banner":13,"created_at":"2026-02-12T14:59:47.252294+00:00","description":null,"handle":"test-handle-ae403c8f160ec46f","hidden_modules":null,"is_managed":false,"link_count":0,"modified_at":"2026-02-12T14:59:47.252294+00:00","name":"test-name-ae403c8f160ec46f","summary":null,"user_count":0,"visible_modules":null},"relationships":{"team_links":{"data":[],"links":{"related":"/api/v2/team/38c0d1d3-69c0-4452-95a0-0115b22f2607/links"}},"user_team_permissions":{"data":null,"links":{"related":"/api/v2/team/38c0d1d3-69c0-4452-95a0-0115b22f2607/permission-settings"}}}}}'
14+
headers:
15+
content-type:
16+
- application/vnd.api+json
17+
status:
18+
code: 201
19+
message: Created
20+
- request:
21+
body: '{"data":{"attributes":{"email":"Test-Update_a_user_s_membership_attributes_on_a_team_returns_OK_response-1770908386@datadoghq.com","title":"user
22+
title"},"type":"users"}}'
23+
headers:
24+
accept:
25+
- application/json
26+
content-type:
27+
- application/json
28+
method: POST
29+
uri: https://api.datadoghq.com/api/v2/users
30+
response:
31+
body:
32+
string: '{"data":{"type":"users","id":"3330c2ed-ac5d-458e-875b-ffc85c436edc","attributes":{"name":null,"handle":"test-update_a_user_s_membership_attributes_on_a_team_returns_ok_response-1770908386@datadoghq.com","created_at":"2026-02-12T14:59:47.812309+00:00","modified_at":"2026-02-12T14:59:47.812309+00:00","email":"test-update_a_user_s_membership_attributes_on_a_team_returns_ok_response-1770908386@datadoghq.com","icon":"https://secure.gravatar.com/avatar/7906350a0aeb9c3285de81609654b5df?s=48&d=retro","title":"user
33+
title","verified":false,"service_account":false,"disabled":false,"allowed_login_methods":[],"status":"Pending","last_login_time":null},"relationships":{"roles":{"data":[]},"org":{"data":{"type":"orgs","id":"4dee724d-00cc-11ea-a77b-570c9d03c6c5"}}}}}
34+
35+
'
36+
headers:
37+
content-type:
38+
- application/json
39+
status:
40+
code: 201
41+
message: Created
42+
- request:
43+
body: '{"data":{"attributes":{"role":"admin"},"relationships":{"user":{"data":{"id":"3330c2ed-ac5d-458e-875b-ffc85c436edc","type":"users"}}},"type":"team_memberships"}}'
44+
headers:
45+
accept:
46+
- application/json
47+
content-type:
48+
- application/json
49+
method: POST
50+
uri: https://api.datadoghq.com/api/v2/team/38c0d1d3-69c0-4452-95a0-0115b22f2607/memberships
51+
response:
52+
body:
53+
string: '{"data":{"id":"TeamMembership-38c0d1d3-69c0-4452-95a0-0115b22f2607-65393600","type":"team_memberships","attributes":{"provisioned_by":null,"provisioned_by_id":"3ad549bf-eba0-11e9-a77a-0705486660d0","role":"admin"},"relationships":{"user":{"data":{"id":"3330c2ed-ac5d-458e-875b-ffc85c436edc","type":"users"}}}},"included":[{"id":"3330c2ed-ac5d-458e-875b-ffc85c436edc","type":"users","attributes":{"disabled":false,"email":"test-update_a_user_s_membership_attributes_on_a_team_returns_ok_response-1770908386@datadoghq.com","handle":"test-update_a_user_s_membership_attributes_on_a_team_returns_ok_response-1770908386@datadoghq.com","icon":"https://secure.gravatar.com/avatar/7906350a0aeb9c3285de81609654b5df?d=retro\u0026s=48","name":null,"service_account":false,"status":"Pending"}}]}'
54+
headers:
55+
content-type:
56+
- application/vnd.api+json
57+
status:
58+
code: 200
59+
message: OK
60+
- request:
61+
body: '{"data":{"attributes":{"role":"admin"},"type":"team_memberships"}}'
62+
headers:
63+
accept:
64+
- application/json
65+
content-type:
66+
- application/json
67+
method: PATCH
68+
uri: https://api.datadoghq.com/api/v2/team/38c0d1d3-69c0-4452-95a0-0115b22f2607/memberships/3330c2ed-ac5d-458e-875b-ffc85c436edc
69+
response:
70+
body:
71+
string: '{"data":{"type":"team_memberships","id":"TeamMembership-38c0d1d3-69c0-4452-95a0-0115b22f2607-65393600","attributes":{"role":"admin","provisioned_by":null,"provisioned_by_id":"3ad549bf-eba0-11e9-a77a-0705486660d0"},"relationships":{"user":{"data":{"type":"users","id":"3330c2ed-ac5d-458e-875b-ffc85c436edc"}}}},"included":[{"type":"users","id":"3330c2ed-ac5d-458e-875b-ffc85c436edc","attributes":{"name":null,"handle":"test-update_a_user_s_membership_attributes_on_a_team_returns_ok_response-1770908386@datadoghq.com","email":"test-update_a_user_s_membership_attributes_on_a_team_returns_ok_response-1770908386@datadoghq.com","icon":"https://secure.gravatar.com/avatar/7906350a0aeb9c3285de81609654b5df?s=48&d=retro","disabled":false,"service_account":false}}]}
72+
73+
'
74+
headers:
75+
content-type:
76+
- application/json
77+
status:
78+
code: 200
79+
message: OK
80+
- request:
81+
body: null
82+
headers:
83+
accept:
84+
- '*/*'
85+
method: DELETE
86+
uri: https://api.datadoghq.com/api/v2/team/38c0d1d3-69c0-4452-95a0-0115b22f2607/memberships/3330c2ed-ac5d-458e-875b-ffc85c436edc
87+
response:
88+
body:
89+
string: ''
90+
headers: {}
91+
status:
92+
code: 204
93+
message: No Content
94+
- request:
95+
body: null
96+
headers:
97+
accept:
98+
- '*/*'
99+
method: DELETE
100+
uri: https://api.datadoghq.com/api/v2/users/3330c2ed-ac5d-458e-875b-ffc85c436edc
101+
response:
102+
body:
103+
string: ''
104+
headers: {}
105+
status:
106+
code: 204
107+
message: No Content
108+
- request:
109+
body: null
110+
headers:
111+
accept:
112+
- '*/*'
113+
method: DELETE
114+
uri: https://api.datadoghq.com/api/v2/team/38c0d1d3-69c0-4452-95a0-0115b22f2607
115+
response:
116+
body:
117+
string: ''
118+
headers: {}
119+
status:
120+
code: 204
121+
message: No Content
122+
version: 1

‎tests/v2/cassettes/test_scenarios/test_update_a_users_membership_attributes_on_a_team_with_invalid_role_returns_api_error_response_response.frozen‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2026-02-12T15:00:05.356Z

‎tests/v2/cassettes/test_scenarios/test_update_a_users_membership_attributes_on_a_team_with_invalid_role_returns_api_error_response_response.yaml‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
interactions:
2+
- request:
3+
body: '{"data":{"attributes":{"handle":"test-handle-ff2b53b6514455c7","name":"test-name-ff2b53b6514455c7"},"type":"team"}}'
4+
headers:
5+
accept:
6+
- application/json
7+
content-type:
8+
- application/json
9+
method: POST
10+
uri: https://api.datadoghq.com/api/v2/team
11+
response:
12+
body:
13+
string: '{"data":{"id":"9c2a3be7-8a43-4f37-bc3d-88248875f867","type":"team","attributes":{"avatar":null,"banner":3,"created_at":"2026-02-12T15:00:05.867555+00:00","description":null,"handle":"test-handle-ff2b53b6514455c7","hidden_modules":null,"is_managed":false,"link_count":0,"modified_at":"2026-02-12T15:00:05.867555+00:00","name":"test-name-ff2b53b6514455c7","summary":null,"user_count":0,"visible_modules":null},"relationships":{"team_links":{"data":[],"links":{"related":"/api/v2/team/9c2a3be7-8a43-4f37-bc3d-88248875f867/links"}},"user_team_permissions":{"data":null,"links":{"related":"/api/v2/team/9c2a3be7-8a43-4f37-bc3d-88248875f867/permission-settings"}}}}}'
14+
headers:
15+
content-type:
16+
- application/vnd.api+json
17+
status:
18+
code: 201
19+
message: Created
20+
- request:
21+
body: '{"data":{"attributes":{"email":"Test-Update_a_user_s_membership_attributes_on_a_team_with_invalid_role_returns_API_error_response_respons-1770908405@datadoghq.com","title":"user
22+
title"},"type":"users"}}'
23+
headers:
24+
accept:
25+
- application/json
26+
content-type:
27+
- application/json
28+
method: POST
29+
uri: https://api.datadoghq.com/api/v2/users
30+
response:
31+
body:
32+
string: '{"data":{"type":"users","id":"eed29272-352e-4bf8-ab48-ad007a1f7179","attributes":{"name":null,"handle":"test-update_a_user_s_membership_attributes_on_a_team_with_invalid_role_returns_api_error_response_respons-1770908405@datadoghq.com","created_at":"2026-02-12T15:00:06.429855+00:00","modified_at":"2026-02-12T15:00:06.429855+00:00","email":"test-update_a_user_s_membership_attributes_on_a_team_with_invalid_role_returns_api_error_response_respons-1770908405@datadoghq.com","icon":"https://secure.gravatar.com/avatar/1a5d1f711a7790783032ea8e4653d473?s=48&d=retro","title":"user
33+
title","verified":false,"service_account":false,"disabled":false,"allowed_login_methods":[],"status":"Pending","last_login_time":null},"relationships":{"roles":{"data":[]},"org":{"data":{"type":"orgs","id":"4dee724d-00cc-11ea-a77b-570c9d03c6c5"}}}}}
34+
35+
'
36+
headers:
37+
content-type:
38+
- application/json
39+
status:
40+
code: 201
41+
message: Created
42+
- request:
43+
body: '{"data":{"attributes":{"role":"admin"},"relationships":{"user":{"data":{"id":"eed29272-352e-4bf8-ab48-ad007a1f7179","type":"users"}}},"type":"team_memberships"}}'
44+
headers:
45+
accept:
46+
- application/json
47+
content-type:
48+
- application/json
49+
method: POST
50+
uri: https://api.datadoghq.com/api/v2/team/9c2a3be7-8a43-4f37-bc3d-88248875f867/memberships
51+
response:
52+
body:
53+
string: '{"data":{"id":"TeamMembership-9c2a3be7-8a43-4f37-bc3d-88248875f867-65393607","type":"team_memberships","attributes":{"provisioned_by":null,"provisioned_by_id":"3ad549bf-eba0-11e9-a77a-0705486660d0","role":"admin"},"relationships":{"user":{"data":{"id":"eed29272-352e-4bf8-ab48-ad007a1f7179","type":"users"}}}},"included":[{"id":"eed29272-352e-4bf8-ab48-ad007a1f7179","type":"users","attributes":{"disabled":false,"email":"test-update_a_user_s_membership_attributes_on_a_team_with_invalid_role_returns_api_error_response_respons-1770908405@datadoghq.com","handle":"test-update_a_user_s_membership_attributes_on_a_team_with_invalid_role_returns_api_error_response_respons-1770908405@datadoghq.com","icon":"https://secure.gravatar.com/avatar/1a5d1f711a7790783032ea8e4653d473?d=retro\u0026s=48","name":null,"service_account":false,"status":"Pending"}}]}'
54+
headers:
55+
content-type:
56+
- application/vnd.api+json
57+
status:
58+
code: 200
59+
message: OK
60+
- request:
61+
body: '{"data":{"attributes":{"role":"member"},"type":"team_memberships"}}'
62+
headers:
63+
accept:
64+
- application/json
65+
content-type:
66+
- application/json
67+
method: PATCH
68+
uri: https://api.datadoghq.com/api/v2/team/9c2a3be7-8a43-4f37-bc3d-88248875f867/memberships/eed29272-352e-4bf8-ab48-ad007a1f7179
69+
response:
70+
body:
71+
string: '{"errors":["{''errors'': [{''detail'': ''Not a valid choice.'', ''source'':
72+
{''pointer'': ''/data/attributes/role''}}]}"]}'
73+
headers:
74+
content-type:
75+
- application/json
76+
status:
77+
code: 400
78+
message: Bad Request
79+
- request:
80+
body: null
81+
headers:
82+
accept:
83+
- '*/*'
84+
method: DELETE
85+
uri: https://api.datadoghq.com/api/v2/team/9c2a3be7-8a43-4f37-bc3d-88248875f867/memberships/eed29272-352e-4bf8-ab48-ad007a1f7179
86+
response:
87+
body:
88+
string: ''
89+
headers: {}
90+
status:
91+
code: 204
92+
message: No Content
93+
- request:
94+
body: null
95+
headers:
96+
accept:
97+
- '*/*'
98+
method: DELETE
99+
uri: https://api.datadoghq.com/api/v2/users/eed29272-352e-4bf8-ab48-ad007a1f7179
100+
response:
101+
body:
102+
string: ''
103+
headers: {}
104+
status:
105+
code: 204
106+
message: No Content
107+
- request:
108+
body: null
109+
headers:
110+
accept:
111+
- '*/*'
112+
method: DELETE
113+
uri: https://api.datadoghq.com/api/v2/team/9c2a3be7-8a43-4f37-bc3d-88248875f867
114+
response:
115+
body:
116+
string: ''
117+
headers: {}
118+
status:
119+
code: 204
120+
message: No Content
121+
version: 1

‎tests/v2/features/given.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1344,6 +1344,10 @@
13441344
},
13451345
{
13461346
"parameters": [
1347+
{
1348+
"name": "team_id",
1349+
"source": "dd_team.data.id"
1350+
},
13471351
{
13481352
"name": "body",
13491353
"value": "{\n \"data\": {\n \"attributes\": {\n \"role\": \"admin\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"{{user.data.id}}\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"team_memberships\"\n }\n}"

0 commit comments

Comments
 (0)