Skip to content

Commit 6e41fce

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 538f9e1 of spec repo
1 parent 7e7c348 commit 6e41fce

File tree

5 files changed

+60
-48
lines changed

5 files changed

+60
-48
lines changed

config/_default/menus/api.en.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4192,7 +4192,7 @@ menu:
41924192
- CreateHostTags
41934193
unstable: []
41944194
order: 3
4195-
- name: Get host tags
4195+
- name: Get Host Tags
41964196
url: '#get-host-tags'
41974197
identifier: tags-get-host-tags
41984198
parent: tags
@@ -4216,9 +4216,9 @@ menu:
42164216
- DeleteHostTags
42174217
unstable: []
42184218
order: 5
4219-
- name: Get Tags
4220-
url: '#get-tags'
4221-
identifier: tags-get-tags
4219+
- name: Get All Host Tags
4220+
url: '#get-all-host-tags'
4221+
identifier: tags-get-all-host-tags
42224222
parent: tags
42234223
generated: true
42244224
params:

content/en/api/v1/tags/examples.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
]
1010
}
1111
},
12-
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> tags</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>A list of tags to apply to the host.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">&lt;any-key&gt;</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of additional properties for tags.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
12+
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> tags</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>A mapping of tags</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">&lt;any-key&gt;</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of host names which contain this tag</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
1313
},
1414
"403": {
1515
"json": {
@@ -84,7 +84,7 @@
8484
"environment:production"
8585
]
8686
},
87-
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags to apply to the host.</p></div>\n </div>\n \n </div>\n </div></div>"
87+
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags attached to a given host.</p></div>\n </div>\n \n </div>\n </div></div>"
8888
},
8989
"403": {
9090
"json": {
@@ -126,7 +126,7 @@
126126
"environment:production"
127127
]
128128
},
129-
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags to apply to the host.</p></div>\n </div>\n \n </div>\n </div></div>"
129+
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags attached to a given host.</p></div>\n </div>\n \n </div>\n </div></div>"
130130
},
131131
"403": {
132132
"json": {
@@ -173,7 +173,7 @@
173173
"environment:production"
174174
]
175175
},
176-
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags to apply to the host.</p></div>\n </div>\n \n </div>\n </div></div>"
176+
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags attached to a given host.</p></div>\n </div>\n \n </div>\n </div></div>"
177177
},
178178
"403": {
179179
"json": {

data/api/v1/full_spec.yaml

Lines changed: 47 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4261,7 +4261,7 @@ components:
42614261
example: false
42624262
type: boolean
42634263
type: object
4264-
HostTags:
4264+
HostTagsInput:
42654265
description: Set of tags to associate with your host.
42664266
properties:
42674267
host:
@@ -4276,6 +4276,21 @@ components:
42764276
type: string
42774277
type: array
42784278
type: object
4279+
HostTagsOutput:
4280+
description: Set of tags to associate with your host.
4281+
properties:
4282+
host:
4283+
description: Your host name.
4284+
example: test.host
4285+
type: string
4286+
tags:
4287+
description: A list of tags attached to a given host.
4288+
items:
4289+
description: A given tag in a list.
4290+
example: environment:production
4291+
type: string
4292+
type: array
4293+
type: object
42794294
HostTotals:
42804295
description: Total number of host currently monitored by Datadog.
42814296
properties:
@@ -18900,18 +18915,18 @@ components:
1890018915
- match
1890118916
type: object
1890218917
TagToHosts:
18903-
description: In this object, the key is the tag, the value is a list of host
18904-
names that are reporting that tag.
18918+
description: In this object, the key is the tag, and the value is a list of
18919+
host names that are reporting that tag.
1890518920
properties:
1890618921
tags:
1890718922
additionalProperties:
18908-
description: A list of additional properties for tags.
18923+
description: A list of host names which contain this tag
1890918924
items:
1891018925
description: A given tag in a list.
1891118926
example: test.metric.host
1891218927
type: string
1891318928
type: array
18914-
description: A list of tags to apply to the host.
18929+
description: A mapping of tags
1891518930
type: object
1891618931
type: object
1891718932
TargetFormatType:
@@ -36781,11 +36796,13 @@ paths:
3678136796
- synthetics_global_variable_write
3678236797
/api/v1/tags/hosts:
3678336798
get:
36784-
description: Return a mapping of tags to hosts for your whole infrastructure.
36799+
description: Returns a mapping of tags to hosts. For each tag, the response
36800+
returns a list of host names that contain this tag. There is a restriction
36801+
of 10k host names from the org that can be attached to tags and returned.
3678536802
operationId: ListHostTags
3678636803
parameters:
36787-
- description: When specified, filters host list to those tags with the specified
36788-
source.
36804+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36805+
Use "user" source for custom-defined tags.
3678936806
in: query
3679036807
name: source
3679136808
required: false
@@ -36816,7 +36833,7 @@ paths:
3681636833
- apiKeyAuth: []
3681736834
appKeyAuth: []
3681836835
- AuthZ: []
36819-
summary: Get Tags
36836+
summary: Get All Host Tags
3682036837
tags:
3682136838
- Tags
3682236839
x-menu-order: 1
@@ -36830,16 +36847,14 @@ paths:
3683036847
for a single host.'
3683136848
operationId: DeleteHostTags
3683236849
parameters:
36833-
- description: This endpoint allows you to remove all user-assigned tags for
36834-
a single host.
36850+
- description: Specified host name to delete tags
3683536851
in: path
3683636852
name: host_name
3683736853
required: true
3683836854
schema:
3683936855
type: string
36840-
- description: 'The source of the tags (for example chef, puppet).
36841-
36842-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
36856+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36857+
Use "user" source for custom-defined tags.
3684336858
in: query
3684436859
name: source
3684536860
required: false
@@ -36870,14 +36885,14 @@ paths:
3687036885
description: Return the list of tags that apply to a given host.
3687136886
operationId: GetHostTags
3687236887
parameters:
36873-
- description: When specified, filters list of tags to those tags with the specified
36874-
source.
36888+
- description: Specified host name to view tags
3687536889
in: path
3687636890
name: host_name
3687736891
required: true
3687836892
schema:
3687936893
type: string
36880-
- description: Source to filter.
36894+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36895+
Use "user" source for custom-defined tags.
3688136896
in: query
3688236897
name: source
3688336898
required: false
@@ -36888,7 +36903,7 @@ paths:
3688836903
content:
3688936904
application/json:
3689036905
schema:
36891-
$ref: '#/components/schemas/HostTags'
36906+
$ref: '#/components/schemas/HostTagsOutput'
3689236907
description: OK
3689336908
'403':
3689436909
content:
@@ -36904,26 +36919,24 @@ paths:
3690436919
description: Not Found
3690536920
'429':
3690636921
$ref: '#/components/responses/TooManyRequestsResponse'
36907-
summary: Get host tags
36922+
summary: Get Host Tags
3690836923
tags:
3690936924
- Tags
3691036925
x-menu-order: 2
3691136926
post:
3691236927
description: 'This endpoint allows you to add new tags to a host,
3691336928

36914-
optionally specifying where these tags come from.'
36929+
optionally specifying what source these tags come from.'
3691536930
operationId: CreateHostTags
3691636931
parameters:
36917-
- description: This endpoint allows you to add new tags to a host, optionally
36918-
specifying where the tags came from.
36932+
- description: Specified host name to add new tags
3691936933
in: path
3692036934
name: host_name
3692136935
required: true
3692236936
schema:
3692336937
type: string
36924-
- description: 'The source of the tags.
36925-
36926-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
36938+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36939+
Use "user" source for custom-defined tags.
3692736940
example: chef
3692836941
in: query
3692936942
name: source
@@ -36934,15 +36947,15 @@ paths:
3693436947
content:
3693536948
application/json:
3693636949
schema:
36937-
$ref: '#/components/schemas/HostTags'
36950+
$ref: '#/components/schemas/HostTagsInput'
3693836951
description: Update host tags request body.
3693936952
required: true
3694036953
responses:
3694136954
'201':
3694236955
content:
3694336956
application/json:
3694436957
schema:
36945-
$ref: '#/components/schemas/HostTags'
36958+
$ref: '#/components/schemas/HostTagsOutput'
3694636959
description: Created
3694736960
'403':
3694836961
content:
@@ -36969,16 +36982,14 @@ paths:
3696936982
an integration source with those supplied in the request.'
3697036983
operationId: UpdateHostTags
3697136984
parameters:
36972-
- description: This endpoint allows you to update/replace all in an integration
36973-
source with those supplied in the request.
36985+
- description: Specified host name to change tags
3697436986
in: path
3697536987
name: host_name
3697636988
required: true
3697736989
schema:
3697836990
type: string
36979-
- description: 'The source of the tags (for example chef, puppet).
36980-
36981-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)'
36991+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36992+
Use "user" source for custom-defined tags.
3698236993
in: query
3698336994
name: source
3698436995
required: false
@@ -36988,15 +36999,15 @@ paths:
3698836999
content:
3698937000
application/json:
3699037001
schema:
36991-
$ref: '#/components/schemas/HostTags'
37002+
$ref: '#/components/schemas/HostTagsInput'
3699237003
description: Add tags to host
3699337004
required: true
3699437005
responses:
3699537006
'201':
3699637007
content:
3699737008
application/json:
3699837009
schema:
36999-
$ref: '#/components/schemas/HostTags'
37010+
$ref: '#/components/schemas/HostTagsOutput'
3700037011
description: OK
3700137012
'403':
3700237013
content:
@@ -40110,7 +40121,8 @@ tags:
4011040121

4011140122
by a source. For example, some valid sources include nagios, hudson, jenkins,
4011240123

40113-
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.
40124+
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. [Complete
40125+
list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)
4011440126

4011540127

4011640128
Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).'

data/api/v1/translate_actions.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1012,19 +1012,19 @@
10121012
"request_schema_description": "Details of the global variable to create."
10131013
},
10141014
"ListHostTags": {
1015-
"description": "Return a mapping of tags to hosts for your whole infrastructure.",
1016-
"summary": "Get Tags"
1015+
"description": "Returns a mapping of tags to hosts. For each tag, the response returns a list of host names that contain this tag. There is a restriction of 10k host names from the org that can be attached to tags and returned.",
1016+
"summary": "Get All Host Tags"
10171017
},
10181018
"DeleteHostTags": {
10191019
"description": "This endpoint allows you to remove all user-assigned tags\nfor a single host.",
10201020
"summary": "Remove host tags"
10211021
},
10221022
"GetHostTags": {
10231023
"description": "Return the list of tags that apply to a given host.",
1024-
"summary": "Get host tags"
1024+
"summary": "Get Host Tags"
10251025
},
10261026
"CreateHostTags": {
1027-
"description": "This endpoint allows you to add new tags to a host,\noptionally specifying where these tags come from.",
1027+
"description": "This endpoint allows you to add new tags to a host,\noptionally specifying what source these tags come from.",
10281028
"summary": "Add tags to a host",
10291029
"request_description": "Update host tags request body.",
10301030
"request_schema_description": "Set of tags to associate with your host."

data/api/v1/translate_tags.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@
121121
},
122122
"tags": {
123123
"name": "Tags",
124-
"description": "The tag endpoint allows you to assign tags to hosts,\nfor example: `role:database`. Those tags are applied to\nall metrics sent by the host. Refer to hosts by name\n(`yourhost.example.com`) when fetching and applying\ntags to a particular host.\n\nThe component of your infrastructure responsible for a tag is identified\nby a source. For example, some valid sources include nagios, hudson, jenkins,\nusers, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.\n\nRead more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/)."
124+
"description": "The tag endpoint allows you to assign tags to hosts,\nfor example: `role:database`. Those tags are applied to\nall metrics sent by the host. Refer to hosts by name\n(`yourhost.example.com`) when fetching and applying\ntags to a particular host.\n\nThe component of your infrastructure responsible for a tag is identified\nby a source. For example, some valid sources include nagios, hudson, jenkins,\nusers, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)\n\nRead more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/)."
125125
},
126126
"timeboards": {
127127
"name": "Timeboards",

0 commit comments

Comments
 (0)