Skip to content

Commit 709912d

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Document new attributes for team models (#1270)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent c24ca67 commit 709912d

File tree

12 files changed

+365
-28
lines changed

12 files changed

+365
-28
lines changed

‎.apigentools-info‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.5",
7-
"regenerated": "2023-08-17 19:37:29.403596",
8-
"spec_repo_commit": "bb17cef0"
7+
"regenerated": "2023-08-21 14:22:27.833087",
8+
"spec_repo_commit": "77f8c067"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.5",
12-
"regenerated": "2023-08-17 19:37:29.416739",
13-
"spec_repo_commit": "bb17cef0"
12+
"regenerated": "2023-08-21 14:22:27.850938",
13+
"spec_repo_commit": "77f8c067"
1414
}
1515
}
1616
}

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

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16002,6 +16002,17 @@ components:
1600216002
TeamAttributes:
1600316003
description: Team attributes
1600416004
properties:
16005+
avatar:
16006+
description: Unicode representation of the avatar for the team, limited
16007+
to a single grapheme
16008+
example: "\U0001F951"
16009+
nullable: true
16010+
type: string
16011+
banner:
16012+
description: Banner selection for the team
16013+
format: int64
16014+
nullable: true
16015+
type: integer
1600516016
created_at:
1600616017
description: Creation date of the team
1600716018
format: date-time
@@ -16015,6 +16026,12 @@ components:
1601516026
example: example-team
1601616027
maxLength: 195
1601716028
type: string
16029+
hidden_modules:
16030+
description: Collection of hidden modules for the team
16031+
items:
16032+
description: String identifier of the module
16033+
type: string
16034+
type: array
1601816035
link_count:
1601916036
description: The number of links belonging to the team
1602016037
format: int32
@@ -16041,6 +16058,12 @@ components:
1604116058
maximum: 2147483647
1604216059
readOnly: true
1604316060
type: integer
16061+
visible_modules:
16062+
description: Collection of visible modules for the team
16063+
items:
16064+
description: String identifier of the module
16065+
type: string
16066+
type: array
1604416067
required:
1604516068
- handle
1604616069
- name
@@ -16061,6 +16084,17 @@ components:
1606116084
TeamCreateAttributes:
1606216085
description: Team creation attributes
1606316086
properties:
16087+
avatar:
16088+
description: Unicode representation of the avatar for the team, limited
16089+
to a single grapheme
16090+
example: "\U0001F951"
16091+
nullable: true
16092+
type: string
16093+
banner:
16094+
description: Banner selection for the team
16095+
format: int64
16096+
nullable: true
16097+
type: integer
1606416098
description:
1606516099
description: Free-form markdown description/content for the team's homepage
1606616100
type: string
@@ -16069,11 +16103,23 @@ components:
1606916103
example: example-team
1607016104
maxLength: 195
1607116105
type: string
16106+
hidden_modules:
16107+
description: Collection of hidden modules for the team
16108+
items:
16109+
description: String identifier of the module
16110+
type: string
16111+
type: array
1607216112
name:
1607316113
description: The name of the team
1607416114
example: Example Team
1607516115
maxLength: 200
1607616116
type: string
16117+
visible_modules:
16118+
description: Collection of visible modules for the team
16119+
items:
16120+
description: String identifier of the module
16121+
type: string
16122+
type: array
1607716123
required:
1607816124
- handle
1607916125
- name
@@ -16344,6 +16390,17 @@ components:
1634416390
TeamUpdateAttributes:
1634516391
description: Team update attributes
1634616392
properties:
16393+
avatar:
16394+
description: Unicode representation of the avatar for the team, limited
16395+
to a single grapheme
16396+
example: "\U0001F951"
16397+
nullable: true
16398+
type: string
16399+
banner:
16400+
description: Banner selection for the team
16401+
format: int64
16402+
nullable: true
16403+
type: integer
1634716404
color:
1634816405
description: An identifier for the color representing the team
1634916406
format: int32
@@ -16358,11 +16415,23 @@ components:
1635816415
example: example-team
1635916416
maxLength: 195
1636016417
type: string
16418+
hidden_modules:
16419+
description: Collection of hidden modules for the team
16420+
items:
16421+
description: String identifier of the module
16422+
type: string
16423+
type: array
1636116424
name:
1636216425
description: The name of the team
1636316426
example: Example Team
1636416427
maxLength: 200
1636516428
type: string
16429+
visible_modules:
16430+
description: Collection of visible modules for the team
16431+
items:
16432+
description: String identifier of the module
16433+
type: string
16434+
type: array
1636616435
required:
1636716436
- handle
1636816437
- name

‎cassettes/v2/Teams_3116892301/Create-a-team-with-V2-fields-returns-CREATED-response_2031254614/frozen.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2023-08-18T22:21:29.944Z"

‎cassettes/v2/Teams_3116892301/Create-a-team-with-V2-fields-returns-CREATED-response_2031254614/recording.har‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
{
2+
"log": {
3+
"_recordingName": "Teams/Create a team with V2 fields returns \"CREATED\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "656622ab0fcfd497d012a67e6296cde5",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 186,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "application/json"
22+
},
23+
{
24+
"_fromType": "array",
25+
"name": "content-type",
26+
"value": "application/json"
27+
}
28+
],
29+
"headersSize": 549,
30+
"httpVersion": "HTTP/1.1",
31+
"method": "POST",
32+
"postData": {
33+
"mimeType": "application/json",
34+
"params": [],
35+
"text": "{\"data\":{\"attributes\":{\"avatar\":\"\ud83e\udd51\",\"banner\":7,\"handle\":\"handle-29fddb97704028c4\",\"hidden_modules\":[\"m3\"],\"name\":\"name-29fddb97704028c4\",\"visible_modules\":[\"m1\",\"m2\"]},\"type\":\"team\"}}"
36+
},
37+
"queryString": [],
38+
"url": "https://api.datadoghq.com/api/v2/team"
39+
},
40+
"response": {
41+
"bodySize": 629,
42+
"content": {
43+
"mimeType": "application/json",
44+
"size": 629,
45+
"text": "{\"data\":{\"type\":\"team\",\"id\":\"94ba28ea-3e15-11ee-8d97-da7ad0900002\",\"attributes\":{\"name\":\"name-29fddb97704028c4\",\"handle\":\"handle-29fddb97704028c4\",\"summary\":null,\"description\":null,\"avatar\":\"\\ud83e\\udd51\",\"banner\":7,\"visible_modules\":[\"m1\",\"m2\"],\"hidden_modules\":[\"m3\"],\"created_at\":\"2023-08-18T22:21:30.549604+00:00\",\"modified_at\":\"2023-08-18T22:21:30.549611+00:00\",\"user_count\":0,\"link_count\":0},\"relationships\":{\"team_links\":{\"links\":{\"related\":\"/api/v2/team/94ba28ea-3e15-11ee-8d97-da7ad0900002/links\"}},\"user_team_permissions\":{\"links\":{\"related\":\"/api/v2/team/94ba28ea-3e15-11ee-8d97-da7ad0900002/permission-settings\"}}}}}\n"
46+
},
47+
"cookies": [],
48+
"headers": [
49+
{
50+
"name": "content-type",
51+
"value": "application/json"
52+
}
53+
],
54+
"headersSize": 654,
55+
"httpVersion": "HTTP/1.1",
56+
"redirectURL": "",
57+
"status": 201,
58+
"statusText": "Created"
59+
},
60+
"startedDateTime": "2023-08-18T22:21:30.488Z",
61+
"time": 157
62+
},
63+
{
64+
"_id": "6bdbbfe457deee8ac666f8bc0d442891",
65+
"_order": 0,
66+
"cache": {},
67+
"request": {
68+
"bodySize": 0,
69+
"cookies": [],
70+
"headers": [
71+
{
72+
"_fromType": "array",
73+
"name": "accept",
74+
"value": "*/*"
75+
}
76+
],
77+
"headersSize": 522,
78+
"httpVersion": "HTTP/1.1",
79+
"method": "DELETE",
80+
"queryString": [],
81+
"url": "https://api.datadoghq.com/api/v2/team/94ba28ea-3e15-11ee-8d97-da7ad0900002"
82+
},
83+
"response": {
84+
"bodySize": 0,
85+
"content": {
86+
"mimeType": "text/plain",
87+
"size": 0
88+
},
89+
"cookies": [],
90+
"headers": [],
91+
"headersSize": 601,
92+
"httpVersion": "HTTP/1.1",
93+
"redirectURL": "",
94+
"status": 204,
95+
"statusText": "No Content"
96+
},
97+
"startedDateTime": "2023-08-18T22:21:30.656Z",
98+
"time": 126
99+
}
100+
],
101+
"pages": [],
102+
"version": "1.2"
103+
}
104+
}

‎cassettes/v2/Teams_3116892301/Update-a-team-returns-OK-response_3744394858/frozen.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2023-07-12T17:29:37.638Z"
1+
"2023-08-18T22:21:30.795Z"

‎cassettes/v2/Teams_3116892301/Update-a-team-returns-OK-response_3744394858/recording.har‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
},
99
"entries": [
1010
{
11-
"_id": "341cb992f3713c23f0959e81f5690fd4",
11+
"_id": "96127d411dc0a108381beaf3abd657b6",
1212
"_order": 0,
1313
"cache": {},
1414
"request": {
@@ -32,17 +32,17 @@
3232
"postData": {
3333
"mimeType": "application/json",
3434
"params": [],
35-
"text": "{\"data\":{\"attributes\":{\"handle\":\"handle-35daf948e7104345\",\"name\":\"name-35daf948e7104345\"},\"type\":\"team\"}}"
35+
"text": "{\"data\":{\"attributes\":{\"handle\":\"handle-368d558fc674f4d3\",\"name\":\"name-368d558fc674f4d3\"},\"type\":\"team\"}}"
3636
},
3737
"queryString": [],
3838
"url": "https://api.datadoghq.com/api/v2/team"
3939
},
4040
"response": {
41-
"bodySize": 540,
41+
"bodySize": 609,
4242
"content": {
4343
"mimeType": "application/json",
44-
"size": 540,
45-
"text": "{\"data\":{\"type\":\"team\",\"id\":\"ad5a151c-20d9-11ee-bfa0-da7ad0900002\",\"attributes\":{\"name\":\"name-35daf948e7104345\",\"handle\":\"handle-35daf948e7104345\",\"summary\":null,\"description\":null,\"created_at\":\"2023-07-12T17:29:38.339300+00:00\",\"modified_at\":\"2023-07-12T17:29:38.339306+00:00\",\"user_count\":0,\"link_count\":0},\"relationships\":{\"team_links\":{\"links\":{\"related\":\"/api/v2/team/ad5a151c-20d9-11ee-bfa0-da7ad0900002/links\"}},\"user_team_permissions\":{\"links\":{\"related\":\"/api/v2/team/ad5a151c-20d9-11ee-bfa0-da7ad0900002/permission-settings\"}}}}}\n"
44+
"size": 609,
45+
"text": "{\"data\":{\"type\":\"team\",\"id\":\"94e8c5a6-3e15-11ee-b7c9-da7ad0900002\",\"attributes\":{\"name\":\"name-368d558fc674f4d3\",\"handle\":\"handle-368d558fc674f4d3\",\"summary\":null,\"description\":null,\"avatar\":null,\"banner\":null,\"visible_modules\":[],\"hidden_modules\":[],\"created_at\":\"2023-08-18T22:21:30.855820+00:00\",\"modified_at\":\"2023-08-18T22:21:30.855826+00:00\",\"user_count\":0,\"link_count\":0},\"relationships\":{\"team_links\":{\"links\":{\"related\":\"/api/v2/team/94e8c5a6-3e15-11ee-b7c9-da7ad0900002/links\"}},\"user_team_permissions\":{\"links\":{\"related\":\"/api/v2/team/94e8c5a6-3e15-11ee-b7c9-da7ad0900002/permission-settings\"}}}}}\n"
4646
},
4747
"cookies": [],
4848
"headers": [
@@ -57,15 +57,15 @@
5757
"status": 201,
5858
"statusText": "Created"
5959
},
60-
"startedDateTime": "2023-07-12T17:29:37.641Z",
61-
"time": 1316
60+
"startedDateTime": "2023-08-18T22:21:30.800Z",
61+
"time": 128
6262
},
6363
{
64-
"_id": "351d12e3d1f7144b8c316d500c46d1f5",
64+
"_id": "48384ce1f8c3808c520d19b62c364e9d",
6565
"_order": 0,
6666
"cache": {},
6767
"request": {
68-
"bodySize": 113,
68+
"bodySize": 194,
6969
"cookies": [],
7070
"headers": [
7171
{
@@ -85,17 +85,17 @@
8585
"postData": {
8686
"mimeType": "application/json",
8787
"params": [],
88-
"text": "{\"data\":{\"attributes\":{\"handle\":\"handle-35daf948e7104345\",\"name\":\"name-35daf948e7104345 updated\"},\"type\":\"team\"}}"
88+
"text": "{\"data\":{\"attributes\":{\"avatar\":\"\ud83e\udd51\",\"banner\":7,\"handle\":\"handle-368d558fc674f4d3\",\"hidden_modules\":[\"m3\"],\"name\":\"name-368d558fc674f4d3 updated\",\"visible_modules\":[\"m1\",\"m2\"]},\"type\":\"team\"}}"
8989
},
9090
"queryString": [],
91-
"url": "https://api.datadoghq.com/api/v2/team/ad5a151c-20d9-11ee-bfa0-da7ad0900002"
91+
"url": "https://api.datadoghq.com/api/v2/team/94e8c5a6-3e15-11ee-b7c9-da7ad0900002"
9292
},
9393
"response": {
94-
"bodySize": 548,
94+
"bodySize": 637,
9595
"content": {
9696
"mimeType": "application/json",
97-
"size": 548,
98-
"text": "{\"data\":{\"type\":\"team\",\"id\":\"ad5a151c-20d9-11ee-bfa0-da7ad0900002\",\"attributes\":{\"name\":\"name-35daf948e7104345 updated\",\"handle\":\"handle-35daf948e7104345\",\"summary\":null,\"description\":null,\"created_at\":\"2023-07-12T17:29:38.339300+00:00\",\"modified_at\":\"2023-07-12T17:29:39.089732+00:00\",\"user_count\":0,\"link_count\":0},\"relationships\":{\"team_links\":{\"links\":{\"related\":\"/api/v2/team/ad5a151c-20d9-11ee-bfa0-da7ad0900002/links\"}},\"user_team_permissions\":{\"links\":{\"related\":\"/api/v2/team/ad5a151c-20d9-11ee-bfa0-da7ad0900002/permission-settings\"}}}}}\n"
97+
"size": 637,
98+
"text": "{\"data\":{\"type\":\"team\",\"id\":\"94e8c5a6-3e15-11ee-b7c9-da7ad0900002\",\"attributes\":{\"name\":\"name-368d558fc674f4d3 updated\",\"handle\":\"handle-368d558fc674f4d3\",\"summary\":null,\"description\":null,\"avatar\":\"\\ud83e\\udd51\",\"banner\":7,\"visible_modules\":[\"m1\",\"m2\"],\"hidden_modules\":[\"m3\"],\"created_at\":\"2023-08-18T22:21:30.855820+00:00\",\"modified_at\":\"2023-08-18T22:21:31.005082+00:00\",\"user_count\":0,\"link_count\":0},\"relationships\":{\"team_links\":{\"links\":{\"related\":\"/api/v2/team/94e8c5a6-3e15-11ee-b7c9-da7ad0900002/links\"}},\"user_team_permissions\":{\"links\":{\"related\":\"/api/v2/team/94e8c5a6-3e15-11ee-b7c9-da7ad0900002/permission-settings\"}}}}}\n"
9999
},
100100
"cookies": [],
101101
"headers": [
@@ -110,11 +110,11 @@
110110
"status": 200,
111111
"statusText": "OK"
112112
},
113-
"startedDateTime": "2023-07-12T17:29:38.971Z",
114-
"time": 141
113+
"startedDateTime": "2023-08-18T22:21:30.934Z",
114+
"time": 121
115115
},
116116
{
117-
"_id": "1f5aec5edfedd8e1c2a1061ef5fbac9d",
117+
"_id": "04a864c3cd783dcd78772e81fe737f50",
118118
"_order": 0,
119119
"cache": {},
120120
"request": {
@@ -127,11 +127,11 @@
127127
"value": "*/*"
128128
}
129129
],
130-
"headersSize": 522,
130+
"headersSize": 521,
131131
"httpVersion": "HTTP/1.1",
132132
"method": "DELETE",
133133
"queryString": [],
134-
"url": "https://api.datadoghq.com/api/v2/team/ad5a151c-20d9-11ee-bfa0-da7ad0900002"
134+
"url": "https://api.datadoghq.com/api/v2/team/94e8c5a6-3e15-11ee-b7c9-da7ad0900002"
135135
},
136136
"response": {
137137
"bodySize": 0,
@@ -147,8 +147,8 @@
147147
"status": 204,
148148
"statusText": "No Content"
149149
},
150-
"startedDateTime": "2023-07-12T17:29:39.118Z",
151-
"time": 153
150+
"startedDateTime": "2023-08-18T22:21:31.062Z",
151+
"time": 117
152152
}
153153
],
154154
"pages": [],

0 commit comments

Comments
 (0)