[REDHOSTS-612] Update Tags API Documentation (#3097)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v1/openapi.yaml

@@ -4219,14 +4219,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 associated with a host.
           items:
             description: A given tag in a list.
             example: environment:production
@@ -18972,18 +18972,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:
@@ -36008,11 +36008,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
@@ -36043,29 +36045,29 @@ paths:
       - apiKeyAuth: []
         appKeyAuth: []
       - AuthZ: []
-      summary: Get Tags
+      summary: Get All Host Tags
       tags:
       - Tags
       x-permission:
         operator: OPEN
         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 from the source
+        "User".'
       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
@@ -36095,14 +36097,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
@@ -36129,25 +36131,25 @@ 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. If tags already exist,
+        appends new tags to the tag list. If no source is specified, defaults to "user".'
       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 add tags. [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. If no source is specified, defaults
+          to "user".
         example: chef
         in: query
         name: source
@@ -36192,16 +36194,15 @@ 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 update tags. [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. If no source specified, defaults
+          to "user".
         in: query
         name: source
         required: false
@@ -39217,7 +39218,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/).'

examples/v1/tags/GetHostTags.ts

@@ -1,5 +1,5 @@
 /**
- * Get host tags returns "OK" response
+ * Get Host Tags returns "OK" response
  */
 
 import { client, v1 } from "@datadog/datadog-api-client";

examples/v1/tags/ListHostTags.ts

@@ -1,5 +1,5 @@
 /**
- * Get Tags returns "OK" response
+ * Get All Host Tags returns "OK" response
  */
 
 import { client, v1 } from "@datadog/datadog-api-client";

features/v1/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

packages/datadog-api-client-v1/apis/TagsApi.ts

@@ -558,7 +558,7 @@ export class TagsApiResponseProcessor {
 
 export interface TagsApiCreateHostTagsRequest {
   /**
-   * This endpoint allows you to add new tags to a host, optionally specifying where the tags came from.
+   * Specified host name to add new tags
    * @type string
    */
   hostName: string;
@@ -568,51 +568,49 @@ export interface TagsApiCreateHostTagsRequest {
    */
   body: HostTags;
   /**
-   * The source of the tags.
-   * [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
+   * Source to add tags. [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. If no source is specified, defaults to "user".
    * @type string
    */
   source?: string;
 }
 
 export interface TagsApiDeleteHostTagsRequest {
   /**
-   * This endpoint allows you to remove all user-assigned tags for a single host.
+   * Specified host name to delete tags
    * @type string
    */
   hostName: string;
   /**
-   * 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).
+   * 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.
    * @type string
    */
   source?: string;
 }
 
 export interface TagsApiGetHostTagsRequest {
   /**
-   * When specified, filters list of tags to those tags with the specified source.
+   * Name of the host to retrieve tags for
    * @type string
    */
   hostName: string;
   /**
-   * Source to filter.
+   * 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.
    * @type string
    */
   source?: string;
 }
 
 export interface TagsApiListHostTagsRequest {
   /**
-   * When specified, filters host list to those tags with the specified source.
+   * 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.
    * @type string
    */
   source?: string;
 }
 
 export interface TagsApiUpdateHostTagsRequest {
   /**
-   * This endpoint allows you to update/replace all in an integration source with those supplied in the request.
+   * Specified host name to change tags
    * @type string
    */
   hostName: string;
@@ -622,8 +620,7 @@ export interface TagsApiUpdateHostTagsRequest {
    */
   body: HostTags;
   /**
-   * 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)
+   * Source to update tags. [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. If no source specified, defaults to "user".
    * @type string
    */
   source?: string;
@@ -648,7 +645,7 @@ export class TagsApi {
 
   /**
    * 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. If tags already exist, appends new tags to the tag list. If no source is specified, defaults to "user".
    * @param param The request object
    */
   public createHostTags(
@@ -671,8 +668,8 @@ export class TagsApi {
   }
 
   /**
-   * 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 from the source "User".
    * @param param The request object
    */
   public deleteHostTags(
@@ -716,7 +713,7 @@ export class TagsApi {
   }
 
   /**
-   * 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 param The request object
    */
   public listHostTags(

packages/datadog-api-client-v1/models/HostTags.ts

@@ -7,15 +7,15 @@
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
 /**
- * Set of tags to associate with your host.
+ * Host name and an array of its tags
  */
 export class HostTags {
   /**
    * Your host name.
    */
   "host"?: string;
   /**
-   * A list of tags to apply to the host.
+   * A list of tags associated with a host.
    */
   "tags"?: Array<string>;
 

packages/datadog-api-client-v1/models/TagToHosts.ts

@@ -7,11 +7,11 @@
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
 /**
- * In this object, the key is the tag, the value is a list of host names that are reporting that tag.
+ * In this object, the key is the tag, and the value is a list of host names that are reporting that tag.
  */
 export class TagToHosts {
   /**
-   * A list of tags to apply to the host.
+   * A mapping of tags to host names
    */
   "tags"?: { [key: string]: Array<string> };