Skip to content

Commit 436e4b5

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Documentation for new device tags endpoints (#1724)
Co-authored-by: ci.datadog-api-spec <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent adbc448 commit 436e4b5

File tree

22 files changed

+924
-5
lines changed

22 files changed

+924
-5
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.6",
7-
"regenerated": "2024-08-02 13:54:22.867521",
8-
"spec_repo_commit": "74b2ffcb"
7+
"regenerated": "2024-08-05 16:34:58.369594",
8+
"spec_repo_commit": "578f6c8c"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-08-02 13:54:22.886245",
13-
"spec_repo_commit": "74b2ffcb"
12+
"regenerated": "2024-08-05 16:34:58.387579",
13+
"spec_repo_commit": "578f6c8c"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11330,6 +11330,37 @@ components:
1133011330
example: /api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2
1133111331
type: string
1133211332
type: object
11333+
ListTagsResponse:
11334+
description: List tags response.
11335+
properties:
11336+
data:
11337+
$ref: '#/components/schemas/ListTagsResponseData'
11338+
type: object
11339+
ListTagsResponseData:
11340+
description: The list tags response data.
11341+
properties:
11342+
attributes:
11343+
$ref: '#/components/schemas/ListTagsResponseDataAttributes'
11344+
id:
11345+
description: The device ID
11346+
example: example:1.2.3.4
11347+
type: string
11348+
type:
11349+
description: The type of the resource. The value should always be tags.
11350+
type: string
11351+
type: object
11352+
ListTagsResponseDataAttributes:
11353+
description: The definition of ListTagsResponseDataAttributes object.
11354+
properties:
11355+
tags:
11356+
description: The list of tags
11357+
example:
11358+
- tag:test
11359+
- tag:testbis
11360+
items:
11361+
type: string
11362+
type: array
11363+
type: object
1133311364
ListTeamsInclude:
1133411365
description: Included related resources optionally requested.
1133511366
enum:
@@ -31582,6 +31613,67 @@ paths:
3158231613
summary: Get the list of interfaces of the device
3158331614
tags:
3158431615
- Network Device Monitoring
31616+
/api/v2/ndm/tags/devices/{device_id}:
31617+
get:
31618+
description: Get the list of tags for a device.
31619+
operationId: ListDeviceUserTags
31620+
parameters:
31621+
- description: The id of the device to fetch tags for.
31622+
example: example:1.2.3.4
31623+
in: path
31624+
name: device_id
31625+
required: true
31626+
schema:
31627+
type: string
31628+
responses:
31629+
'200':
31630+
content:
31631+
application/json:
31632+
schema:
31633+
$ref: '#/components/schemas/ListTagsResponse'
31634+
description: OK
31635+
'403':
31636+
$ref: '#/components/responses/ForbiddenResponse'
31637+
'404':
31638+
$ref: '#/components/responses/NotFoundResponse'
31639+
'429':
31640+
$ref: '#/components/responses/TooManyRequestsResponse'
31641+
summary: Get the list of tags for a device
31642+
tags:
31643+
- Network Device Monitoring
31644+
patch:
31645+
description: Update the tags for a device.
31646+
operationId: UpdateDeviceUserTags
31647+
parameters:
31648+
- description: The id of the device to update tags for.
31649+
example: example:1.2.3.4
31650+
in: path
31651+
name: device_id
31652+
required: true
31653+
schema:
31654+
type: string
31655+
requestBody:
31656+
content:
31657+
application/json:
31658+
schema:
31659+
$ref: '#/components/schemas/ListTagsResponse'
31660+
required: true
31661+
responses:
31662+
'200':
31663+
content:
31664+
application/json:
31665+
schema:
31666+
$ref: '#/components/schemas/ListTagsResponse'
31667+
description: OK
31668+
'403':
31669+
$ref: '#/components/responses/ForbiddenResponse'
31670+
'404':
31671+
$ref: '#/components/responses/NotFoundResponse'
31672+
'429':
31673+
$ref: '#/components/responses/TooManyRequestsResponse'
31674+
summary: Update the tags for a device
31675+
tags:
31676+
- Network Device Monitoring
3158531677
/api/v2/org_configs:
3158631678
get:
3158731679
description: Returns all Org Configs (name, description, and value).

‎cassettes/v2/Network-Device-Monitoring_315763993/Get-the-device-details-returns-OK-response_3307327934/frozen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2024-07-04T16:51:27.417Z"
1+
"2024-07-25T12:51:06.792Z"

‎cassettes/v2/Network-Device-Monitoring_315763993/Get-the-list-of-tags-for-a-device-returns-Not-Found-response_2649495831/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2024-07-29T13:20:36.111Z"

‎cassettes/v2/Network-Device-Monitoring_315763993/Get-the-list-of-tags-for-a-device-returns-Not-Found-response_2649495831/recording.har

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
{
2+
"log": {
3+
"_recordingName": "Network Device Monitoring/Get the list of tags for a device returns \"Not Found\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "f71494b8ba4f0260922acf47f8383617",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 0,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "application/json"
22+
}
23+
],
24+
"headersSize": 519,
25+
"httpVersion": "HTTP/1.1",
26+
"method": "GET",
27+
"queryString": [],
28+
"url": "https://api.datadoghq.com/api/v2/ndm/tags/devices/unknown_device_id"
29+
},
30+
"response": {
31+
"bodySize": 49,
32+
"content": {
33+
"mimeType": "application/vnd.api+json",
34+
"size": 49,
35+
"text": "{\"errors\":[{\"status\":\"404\",\"title\":\"Not Found\"}]}"
36+
},
37+
"cookies": [],
38+
"headers": [
39+
{
40+
"name": "content-type",
41+
"value": "application/vnd.api+json"
42+
}
43+
],
44+
"headersSize": 522,
45+
"httpVersion": "HTTP/1.1",
46+
"redirectURL": "",
47+
"status": 404,
48+
"statusText": "Not Found"
49+
},
50+
"startedDateTime": "2024-07-29T13:20:36.118Z",
51+
"time": 442
52+
}
53+
],
54+
"pages": [],
55+
"version": "1.2"
56+
}
57+
}

‎cassettes/v2/Network-Device-Monitoring_315763993/Get-the-list-of-tags-for-a-device-returns-OK-response_1735661422/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2024-07-30T13:27:40.522Z"

‎cassettes/v2/Network-Device-Monitoring_315763993/Get-the-list-of-tags-for-a-device-returns-OK-response_1735661422/recording.har

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
{
2+
"log": {
3+
"_recordingName": "Network Device Monitoring/Get the list of tags for a device returns \"OK\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "39a92be54468482e8374383acb02d1be",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 0,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "application/json"
22+
}
23+
],
24+
"headersSize": 532,
25+
"httpVersion": "HTTP/1.1",
26+
"method": "GET",
27+
"queryString": [],
28+
"url": "https://api.datadoghq.com/api/v2/ndm/tags/devices/default_device"
29+
},
30+
"response": {
31+
"bodySize": 99,
32+
"content": {
33+
"mimeType": "application/vnd.api+json",
34+
"size": 99,
35+
"text": "{\"data\":{\"id\":\"default_device\",\"type\":\"tags\",\"attributes\":{\"tags\":[\"tag:test\",\"tag:testbis\"]}}}"
36+
},
37+
"cookies": [],
38+
"headers": [
39+
{
40+
"name": "content-type",
41+
"value": "application/vnd.api+json"
42+
}
43+
],
44+
"headersSize": 522,
45+
"httpVersion": "HTTP/1.1",
46+
"redirectURL": "",
47+
"status": 200,
48+
"statusText": "OK"
49+
},
50+
"startedDateTime": "2024-07-30T13:27:40.531Z",
51+
"time": 330
52+
}
53+
],
54+
"pages": [],
55+
"version": "1.2"
56+
}
57+
}

‎cassettes/v2/Network-Device-Monitoring_315763993/Update-the-tags-for-a-device-returns-Not-Found-response_4009460449/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2024-07-29T13:20:36.885Z"

‎cassettes/v2/Network-Device-Monitoring_315763993/Update-the-tags-for-a-device-returns-Not-Found-response_4009460449/recording.har

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
{
2+
"log": {
3+
"_recordingName": "Network Device Monitoring/Update the tags for a device returns \"Not Found\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "f4d68225d43bb7def88b289c1d3d9eb1",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 98,
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": 575,
30+
"httpVersion": "HTTP/1.1",
31+
"method": "PATCH",
32+
"postData": {
33+
"mimeType": "application/json",
34+
"params": [],
35+
"text": "{\"data\":{\"attributes\":{\"tags\":[\"tag:test\",\"tag:testbis\"]},\"id\":\"unknown_device_id\",\"type\":\"tags\"}}"
36+
},
37+
"queryString": [],
38+
"url": "https://api.datadoghq.com/api/v2/ndm/tags/devices/unknown_device_id"
39+
},
40+
"response": {
41+
"bodySize": 49,
42+
"content": {
43+
"mimeType": "application/vnd.api+json",
44+
"size": 49,
45+
"text": "{\"errors\":[{\"status\":\"404\",\"title\":\"Not Found\"}]}"
46+
},
47+
"cookies": [],
48+
"headers": [
49+
{
50+
"name": "content-type",
51+
"value": "application/vnd.api+json"
52+
}
53+
],
54+
"headersSize": 522,
55+
"httpVersion": "HTTP/1.1",
56+
"redirectURL": "",
57+
"status": 404,
58+
"statusText": "Not Found"
59+
},
60+
"startedDateTime": "2024-07-29T13:20:36.887Z",
61+
"time": 284
62+
}
63+
],
64+
"pages": [],
65+
"version": "1.2"
66+
}
67+
}

‎cassettes/v2/Network-Device-Monitoring_315763993/Update-the-tags-for-a-device-returns-OK-response_781757616/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2024-07-29T13:20:37.177Z"

0 commit comments

Comments
 (0)