diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index d9bb88a10f2..e15fd27d10b 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.generator/schemas/v1/openapi.yaml @@ -4180,14 +4180,14 @@ components: type: boolean type: object HostTags: - description: Set of tags to associate with your host. + description: Host name and an array of its tags properties: host: description: Your host name. example: test.host type: string tags: - description: A list of tags to apply to the host. + description: A list of tags attached to a given host. items: description: A given tag in a list. example: environment:production @@ -18689,18 +18689,18 @@ components: - match type: object TagToHosts: - description: In this object, the key is the tag, the value is a list of host - names that are reporting that tag. + description: In this object, the key is the tag, and the value is a list of + host names that are reporting that tag. properties: tags: additionalProperties: - description: A list of additional properties for tags. + description: A list of host names which contain this tag items: description: A given tag in a list. example: test.metric.host type: string type: array - description: A list of tags to apply to the host. + description: A mapping of tags to host names type: object type: object TargetFormatType: @@ -35712,11 +35712,13 @@ paths: - synthetics_global_variable_write /api/v1/tags/hosts: get: - description: Return a mapping of tags to hosts for your whole infrastructure. + 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 total host names from the org that can be attached to tags and returned. operationId: ListHostTags parameters: - - description: When specified, filters host list to those tags with the specified - source. + - description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). + Use "user" source for custom-defined tags. in: query name: source required: false @@ -35747,7 +35749,7 @@ paths: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] - summary: Get Tags + summary: Get All Host Tags tags: - Tags x-permission: @@ -35755,21 +35757,20 @@ paths: permissions: [] /api/v1/tags/hosts/{host_name}: delete: - description: 'This endpoint allows you to remove all user-assigned tags + description: 'This endpoint allows you to remove all tags - for a single host.' + for a single host. If no source is specified, only deletes tags with no source.' operationId: DeleteHostTags parameters: - - description: This endpoint allows you to remove all user-assigned tags for - a single host. + - description: Specified host name to delete tags in: path name: host_name required: true schema: type: string - - description: 'The source of the tags (for example chef, puppet). - - [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).' + - description: Source of the tags to be deleted. [Complete list of source attribute + values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). + Use "user" source for custom-defined tags. in: query name: source required: false @@ -35799,14 +35800,14 @@ paths: description: Return the list of tags that apply to a given host. operationId: GetHostTags parameters: - - description: When specified, filters list of tags to those tags with the specified - source. + - description: Name of the host to retrieve tags for in: path name: host_name required: true schema: type: string - - description: Source to filter. + - description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). + Use "user" source for custom-defined tags. in: query name: source required: false @@ -35833,25 +35834,23 @@ paths: description: Not Found '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get host tags + summary: Get Host Tags tags: - Tags post: description: 'This endpoint allows you to add new tags to a host, - optionally specifying where these tags come from.' + optionally specifying what source these tags come from.' operationId: CreateHostTags parameters: - - description: This endpoint allows you to add new tags to a host, optionally - specifying where the tags came from. + - description: Specified host name to add new tags in: path name: host_name required: true schema: type: string - - description: 'The source of the tags. - - [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).' + - description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). + Use "user" source for custom-defined tags. example: chef in: query name: source @@ -35896,16 +35895,14 @@ paths: an integration source with those supplied in the request.' operationId: UpdateHostTags parameters: - - description: This endpoint allows you to update/replace all in an integration - source with those supplied in the request. + - description: Specified host name to change tags in: path name: host_name required: true schema: type: string - - description: 'The source of the tags (for example chef, puppet). - - [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)' + - description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). + Use "user" source for custom-defined tags. in: query name: source required: false @@ -38918,7 +38915,8 @@ tags: by a source. For example, some valid sources include nagios, hudson, jenkins, - users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. + users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. Find a complete + list of source type names under [API Source Attributes](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).' diff --git a/examples/v1/tags/GetHostTags.java b/examples/v1/tags/GetHostTags.java index 41cbdae0358..af6b37e8a0a 100644 --- a/examples/v1/tags/GetHostTags.java +++ b/examples/v1/tags/GetHostTags.java @@ -1,4 +1,4 @@ -// Get host tags returns "OK" response +// Get Host Tags returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; diff --git a/examples/v1/tags/ListHostTags.java b/examples/v1/tags/ListHostTags.java index a63fe39f365..5a7cb72c8ff 100644 --- a/examples/v1/tags/ListHostTags.java +++ b/examples/v1/tags/ListHostTags.java @@ -1,4 +1,4 @@ -// Get Tags returns "OK" response +// Get All Host Tags returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; diff --git a/src/main/java/com/datadog/api/client/v1/api/TagsApi.java b/src/main/java/com/datadog/api/client/v1/api/TagsApi.java index bb99d2b0979..d79d676f9ae 100644 --- a/src/main/java/com/datadog/api/client/v1/api/TagsApi.java +++ b/src/main/java/com/datadog/api/client/v1/api/TagsApi.java @@ -52,9 +52,10 @@ public static class CreateHostTagsOptionalParameters { /** * Set source. * - * @param source The source of the tags. Complete - * list of source attribute values. (optional) + * list of source attribute values. Use "user" source for custom-defined tags. + * (optional) * @return CreateHostTagsOptionalParameters */ public CreateHostTagsOptionalParameters source(String source) { @@ -68,8 +69,7 @@ public CreateHostTagsOptionalParameters source(String source) { * *

See {@link #createHostTagsWithHttpInfo}. * - * @param hostName This endpoint allows you to add new tags to a host, optionally specifying where - * the tags came from. (required) + * @param hostName Specified host name to add new tags (required) * @param body Update host tags request body. (required) * @return HostTags * @throws ApiException if fails to make API call @@ -84,8 +84,7 @@ public HostTags createHostTags(String hostName, HostTags body) throws ApiExcepti * *

See {@link #createHostTagsWithHttpInfoAsync}. * - * @param hostName This endpoint allows you to add new tags to a host, optionally specifying where - * the tags came from. (required) + * @param hostName Specified host name to add new tags (required) * @param body Update host tags request body. (required) * @return CompletableFuture<HostTags> */ @@ -102,8 +101,7 @@ public CompletableFuture createHostTagsAsync(String hostName, HostTags * *

See {@link #createHostTagsWithHttpInfo}. * - * @param hostName This endpoint allows you to add new tags to a host, optionally specifying where - * the tags came from. (required) + * @param hostName Specified host name to add new tags (required) * @param body Update host tags request body. (required) * @param parameters Optional parameters for the request. * @return HostTags @@ -120,8 +118,7 @@ public HostTags createHostTags( * *

See {@link #createHostTagsWithHttpInfoAsync}. * - * @param hostName This endpoint allows you to add new tags to a host, optionally specifying where - * the tags came from. (required) + * @param hostName Specified host name to add new tags (required) * @param body Update host tags request body. (required) * @param parameters Optional parameters for the request. * @return CompletableFuture<HostTags> @@ -136,11 +133,10 @@ public CompletableFuture createHostTagsAsync( } /** - * This endpoint allows you to add new tags to a host, optionally specifying where these tags come - * from. + * This endpoint allows you to add new tags to a host, optionally specifying what source these + * tags come from. * - * @param hostName This endpoint allows you to add new tags to a host, optionally specifying where - * the tags came from. (required) + * @param hostName Specified host name to add new tags (required) * @param body Update host tags request body. (required) * @param parameters Optional parameters for the request. * @return ApiResponse<HostTags> @@ -207,8 +203,7 @@ public ApiResponse createHostTagsWithHttpInfo( * *

See {@link #createHostTagsWithHttpInfo}. * - * @param hostName This endpoint allows you to add new tags to a host, optionally specifying where - * the tags came from. (required) + * @param hostName Specified host name to add new tags (required) * @param body Update host tags request body. (required) * @param parameters Optional parameters for the request. * @return CompletableFuture<ApiResponse<HostTags>> @@ -279,9 +274,10 @@ public static class DeleteHostTagsOptionalParameters { /** * Set source. * - * @param source The source of the tags (for example chef, puppet). Complete - * list of source attribute values. (optional) + * list of source attribute values. Use "user" source for custom-defined tags. + * (optional) * @return DeleteHostTagsOptionalParameters */ public DeleteHostTagsOptionalParameters source(String source) { @@ -295,8 +291,7 @@ public DeleteHostTagsOptionalParameters source(String source) { * *

See {@link #deleteHostTagsWithHttpInfo}. * - * @param hostName This endpoint allows you to remove all user-assigned tags for a single host. - * (required) + * @param hostName Specified host name to delete tags (required) * @throws ApiException if fails to make API call */ public void deleteHostTags(String hostName) throws ApiException { @@ -308,8 +303,7 @@ public void deleteHostTags(String hostName) throws ApiException { * *

See {@link #deleteHostTagsWithHttpInfoAsync}. * - * @param hostName This endpoint allows you to remove all user-assigned tags for a single host. - * (required) + * @param hostName Specified host name to delete tags (required) * @return CompletableFuture */ public CompletableFuture deleteHostTagsAsync(String hostName) { @@ -325,8 +319,7 @@ public CompletableFuture deleteHostTagsAsync(String hostName) { * *

See {@link #deleteHostTagsWithHttpInfo}. * - * @param hostName This endpoint allows you to remove all user-assigned tags for a single host. - * (required) + * @param hostName Specified host name to delete tags (required) * @param parameters Optional parameters for the request. * @throws ApiException if fails to make API call */ @@ -340,8 +333,7 @@ public void deleteHostTags(String hostName, DeleteHostTagsOptionalParameters par * *

See {@link #deleteHostTagsWithHttpInfoAsync}. * - * @param hostName This endpoint allows you to remove all user-assigned tags for a single host. - * (required) + * @param hostName Specified host name to delete tags (required) * @param parameters Optional parameters for the request. * @return CompletableFuture */ @@ -355,10 +347,10 @@ public CompletableFuture deleteHostTagsAsync( } /** - * This endpoint allows you to remove all user-assigned tags for a single host. + * This endpoint allows you to remove all tags for a single host. If no source is specified, only + * deletes tags with no source. * - * @param hostName This endpoint allows you to remove all user-assigned tags for a single host. - * (required) + * @param hostName Specified host name to delete tags (required) * @param parameters Optional parameters for the request. * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -417,8 +409,7 @@ public ApiResponse deleteHostTagsWithHttpInfo( * *

See {@link #deleteHostTagsWithHttpInfo}. * - * @param hostName This endpoint allows you to remove all user-assigned tags for a single host. - * (required) + * @param hostName Specified host name to delete tags (required) * @param parameters Optional parameters for the request. * @return CompletableFuture<ApiResponse<Void>> */ @@ -479,7 +470,10 @@ public static class GetHostTagsOptionalParameters { /** * Set source. * - * @param source Source to filter. (optional) + * @param source Source to filter. Complete + * list of source attribute values. Use "user" source for custom-defined tags. + * (optional) * @return GetHostTagsOptionalParameters */ public GetHostTagsOptionalParameters source(String source) { @@ -489,12 +483,11 @@ public GetHostTagsOptionalParameters source(String source) { } /** - * Get host tags. + * Get Host Tags. * *

See {@link #getHostTagsWithHttpInfo}. * - * @param hostName When specified, filters list of tags to those tags with the specified source. - * (required) + * @param hostName Name of the host to retrieve tags for (required) * @return HostTags * @throws ApiException if fails to make API call */ @@ -503,12 +496,11 @@ public HostTags getHostTags(String hostName) throws ApiException { } /** - * Get host tags. + * Get Host Tags. * *

See {@link #getHostTagsWithHttpInfoAsync}. * - * @param hostName When specified, filters list of tags to those tags with the specified source. - * (required) + * @param hostName Name of the host to retrieve tags for (required) * @return CompletableFuture<HostTags> */ public CompletableFuture getHostTagsAsync(String hostName) { @@ -520,12 +512,11 @@ public CompletableFuture getHostTagsAsync(String hostName) { } /** - * Get host tags. + * Get Host Tags. * *

See {@link #getHostTagsWithHttpInfo}. * - * @param hostName When specified, filters list of tags to those tags with the specified source. - * (required) + * @param hostName Name of the host to retrieve tags for (required) * @param parameters Optional parameters for the request. * @return HostTags * @throws ApiException if fails to make API call @@ -536,12 +527,11 @@ public HostTags getHostTags(String hostName, GetHostTagsOptionalParameters param } /** - * Get host tags. + * Get Host Tags. * *

See {@link #getHostTagsWithHttpInfoAsync}. * - * @param hostName When specified, filters list of tags to those tags with the specified source. - * (required) + * @param hostName Name of the host to retrieve tags for (required) * @param parameters Optional parameters for the request. * @return CompletableFuture<HostTags> */ @@ -557,8 +547,7 @@ public CompletableFuture getHostTagsAsync( /** * Return the list of tags that apply to a given host. * - * @param hostName When specified, filters list of tags to those tags with the specified source. - * (required) + * @param hostName Name of the host to retrieve tags for (required) * @param parameters Optional parameters for the request. * @return ApiResponse<HostTags> * @throws ApiException if fails to make API call @@ -613,12 +602,11 @@ public ApiResponse getHostTagsWithHttpInfo( } /** - * Get host tags. + * Get Host Tags. * *

See {@link #getHostTagsWithHttpInfo}. * - * @param hostName When specified, filters list of tags to those tags with the specified source. - * (required) + * @param hostName Name of the host to retrieve tags for (required) * @param parameters Optional parameters for the request. * @return CompletableFuture<ApiResponse<HostTags>> */ @@ -679,7 +667,9 @@ public static class ListHostTagsOptionalParameters { /** * Set source. * - * @param source When specified, filters host list to those tags with the specified source. + * @param source Source to filter. Complete + * list of source attribute values. Use "user" source for custom-defined tags. * (optional) * @return ListHostTagsOptionalParameters */ @@ -690,7 +680,7 @@ public ListHostTagsOptionalParameters source(String source) { } /** - * Get Tags. + * Get All Host Tags. * *

See {@link #listHostTagsWithHttpInfo}. * @@ -702,7 +692,7 @@ public TagToHosts listHostTags() throws ApiException { } /** - * Get Tags. + * Get All Host Tags. * *

See {@link #listHostTagsWithHttpInfoAsync}. * @@ -717,7 +707,7 @@ public CompletableFuture listHostTagsAsync() { } /** - * Get Tags. + * Get All Host Tags. * *

See {@link #listHostTagsWithHttpInfo}. * @@ -730,7 +720,7 @@ public TagToHosts listHostTags(ListHostTagsOptionalParameters parameters) throws } /** - * Get Tags. + * Get All Host Tags. * *

See {@link #listHostTagsWithHttpInfoAsync}. * @@ -747,7 +737,9 @@ public CompletableFuture listHostTagsAsync( } /** - * Return a mapping of tags to hosts for your whole infrastructure. + * 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 total host names from the org that can be + * attached to tags and returned. * * @param parameters Optional parameters for the request. * @return ApiResponse<TagToHosts> @@ -795,7 +787,7 @@ public ApiResponse listHostTagsWithHttpInfo(ListHostTagsOptionalPara } /** - * Get Tags. + * Get All Host Tags. * *

See {@link #listHostTagsWithHttpInfo}. * @@ -848,9 +840,10 @@ public static class UpdateHostTagsOptionalParameters { /** * Set source. * - * @param source The source of the tags (for example chef, puppet). Complete - * list of source attribute values (optional) + * list of source attribute values. Use "user" source for custom-defined tags. + * (optional) * @return UpdateHostTagsOptionalParameters */ public UpdateHostTagsOptionalParameters source(String source) { @@ -864,8 +857,7 @@ public UpdateHostTagsOptionalParameters source(String source) { * *

See {@link #updateHostTagsWithHttpInfo}. * - * @param hostName This endpoint allows you to update/replace all in an integration source with - * those supplied in the request. (required) + * @param hostName Specified host name to change tags (required) * @param body Add tags to host (required) * @return HostTags * @throws ApiException if fails to make API call @@ -880,8 +872,7 @@ public HostTags updateHostTags(String hostName, HostTags body) throws ApiExcepti * *

See {@link #updateHostTagsWithHttpInfoAsync}. * - * @param hostName This endpoint allows you to update/replace all in an integration source with - * those supplied in the request. (required) + * @param hostName Specified host name to change tags (required) * @param body Add tags to host (required) * @return CompletableFuture<HostTags> */ @@ -898,8 +889,7 @@ public CompletableFuture updateHostTagsAsync(String hostName, HostTags * *

See {@link #updateHostTagsWithHttpInfo}. * - * @param hostName This endpoint allows you to update/replace all in an integration source with - * those supplied in the request. (required) + * @param hostName Specified host name to change tags (required) * @param body Add tags to host (required) * @param parameters Optional parameters for the request. * @return HostTags @@ -916,8 +906,7 @@ public HostTags updateHostTags( * *

See {@link #updateHostTagsWithHttpInfoAsync}. * - * @param hostName This endpoint allows you to update/replace all in an integration source with - * those supplied in the request. (required) + * @param hostName Specified host name to change tags (required) * @param body Add tags to host (required) * @param parameters Optional parameters for the request. * @return CompletableFuture<HostTags> @@ -935,8 +924,7 @@ public CompletableFuture updateHostTagsAsync( * This endpoint allows you to update/replace all tags in an integration source with those * supplied in the request. * - * @param hostName This endpoint allows you to update/replace all in an integration source with - * those supplied in the request. (required) + * @param hostName Specified host name to change tags (required) * @param body Add tags to host (required) * @param parameters Optional parameters for the request. * @return ApiResponse<HostTags> @@ -1003,8 +991,7 @@ public ApiResponse updateHostTagsWithHttpInfo( * *

See {@link #updateHostTagsWithHttpInfo}. * - * @param hostName This endpoint allows you to update/replace all in an integration source with - * those supplied in the request. (required) + * @param hostName Specified host name to change tags (required) * @param body Add tags to host (required) * @param parameters Optional parameters for the request. * @return CompletableFuture<ApiResponse<HostTags>> diff --git a/src/main/java/com/datadog/api/client/v1/model/HostTags.java b/src/main/java/com/datadog/api/client/v1/model/HostTags.java index fda1c74e074..738b39b95d8 100644 --- a/src/main/java/com/datadog/api/client/v1/model/HostTags.java +++ b/src/main/java/com/datadog/api/client/v1/model/HostTags.java @@ -18,7 +18,7 @@ import java.util.Map; import java.util.Objects; -/** Set of tags to associate with your host. */ +/** Host name and an array of its tags */ @JsonPropertyOrder({HostTags.JSON_PROPERTY_HOST, HostTags.JSON_PROPERTY_TAGS}) @jakarta.annotation.Generated( value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator") @@ -65,7 +65,7 @@ public HostTags addTagsItem(String tagsItem) { } /** - * A list of tags to apply to the host. + * A list of tags attached to a given host. * * @return tags */ diff --git a/src/main/java/com/datadog/api/client/v1/model/TagToHosts.java b/src/main/java/com/datadog/api/client/v1/model/TagToHosts.java index 2cc5d52c271..4048f2f6cb0 100644 --- a/src/main/java/com/datadog/api/client/v1/model/TagToHosts.java +++ b/src/main/java/com/datadog/api/client/v1/model/TagToHosts.java @@ -18,7 +18,7 @@ import java.util.Objects; /** - * In this object, the key is the tag, the value is a list of host names that are reporting that + * In this object, the key is the tag, and the value is a list of host names that are reporting that * tag. */ @JsonPropertyOrder({TagToHosts.JSON_PROPERTY_TAGS}) @@ -43,7 +43,7 @@ public TagToHosts putTagsItem(String key, List tagsItem) { } /** - * A list of tags to apply to the host. + * A mapping of tags to host names * * @return tags */ diff --git a/src/test/resources/com/datadog/api/client/v1/api/tags.feature b/src/test/resources/com/datadog/api/client/v1/api/tags.feature index 36e1eabfdc2..d6557ca1882 100644 --- a/src/test/resources/com/datadog/api/client/v1/api/tags.feature +++ b/src/test/resources/com/datadog/api/client/v1/api/tags.feature @@ -6,8 +6,11 @@ Feature: Tags tags to a particular host. The component of your infrastructure responsible for a tag is identified by a source. For example, some valid sources include nagios, hudson, jenkins, users, feed, chef, puppet, git, - bitbucket, fabric, capistrano, etc. Read more about tags on [Getting - Started with Tags](https://docs.datadoghq.com/getting_started/tagging/). + bitbucket, fabric, capistrano, etc. Find a complete list of source type + names under [API Source + Attributes](https://docs.datadoghq.com/integrations/faq/list-of-api- + source-attribute-value). Read more about tags on [Getting Started with + Tags](https://docs.datadoghq.com/getting_started/tagging/). Background: Given a valid "apiKeyAuth" key in the system @@ -31,26 +34,26 @@ Feature: Tags Then the response status is 404 Not Found @generated @skip @team:DataDog/core-index - Scenario: Get Tags returns "Not Found" response + Scenario: Get All Host Tags returns "Not Found" response Given new "ListHostTags" request When the request is sent Then the response status is 404 Not Found @generated @skip @team:DataDog/core-index - Scenario: Get Tags returns "OK" response + Scenario: Get All Host Tags returns "OK" response Given new "ListHostTags" request When the request is sent Then the response status is 200 OK @generated @skip @team:DataDog/core-index - Scenario: Get host tags returns "Not Found" response + Scenario: Get Host Tags returns "Not Found" response Given new "GetHostTags" request And request contains "host_name" parameter from "REPLACE.ME" When the request is sent Then the response status is 404 Not Found @generated @skip @team:DataDog/core-index - Scenario: Get host tags returns "OK" response + Scenario: Get Host Tags returns "OK" response Given new "GetHostTags" request And request contains "host_name" parameter from "REPLACE.ME" When the request is sent