From 28350b49f7f2869bb9dcf706e0b62fdf63b515a5 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Fri, 19 Dec 2025 16:49:56 +0000 Subject: [PATCH] Regenerate client from commit 10b360f of spec repo --- .generator/schemas/v1/openapi.yaml | 64 +++++++++---------- examples/v1/tags/GetHostTags.rb | 2 +- examples/v1/tags/ListHostTags.rb | 2 +- features/v1/tags.feature | 15 +++-- lib/datadog_api_client/v1/api/tags_api.rb | 34 +++++----- lib/datadog_api_client/v1/models/host_tags.rb | 4 +- .../v1/models/tag_to_hosts.rb | 4 +- 7 files changed, 63 insertions(+), 62 deletions(-) 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.rb b/examples/v1/tags/GetHostTags.rb index b2ca9e0a118..e69699394ea 100644 --- a/examples/v1/tags/GetHostTags.rb +++ b/examples/v1/tags/GetHostTags.rb @@ -1,4 +1,4 @@ -# Get host tags returns "OK" response +# Get Host Tags returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::TagsAPI.new diff --git a/examples/v1/tags/ListHostTags.rb b/examples/v1/tags/ListHostTags.rb index 64d438a3d8f..b69d45d004b 100644 --- a/examples/v1/tags/ListHostTags.rb +++ b/examples/v1/tags/ListHostTags.rb @@ -1,4 +1,4 @@ -# Get Tags returns "OK" response +# Get All Host Tags returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::TagsAPI.new diff --git a/features/v1/tags.feature b/features/v1/tags.feature index 36e1eabfdc2..d6557ca1882 100644 --- a/features/v1/tags.feature +++ b/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 diff --git a/lib/datadog_api_client/v1/api/tags_api.rb b/lib/datadog_api_client/v1/api/tags_api.rb index 7f07a24ccb4..7a481328aa7 100644 --- a/lib/datadog_api_client/v1/api/tags_api.rb +++ b/lib/datadog_api_client/v1/api/tags_api.rb @@ -34,12 +34,12 @@ def create_host_tags(host_name, body, opts = {}) # Add tags to a host. # # 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. # - # @param host_name [String] This endpoint allows you to add new tags to a host, optionally specifying where the tags came from. + # @param host_name [String] Specified host name to add new tags # @param body [HostTags] Update host tags request body. # @param opts [Hash] the optional parameters - # @option opts [String] :source The source of the tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). + # @option opts [String] :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. # @return [Array<(HostTags, Integer, Hash)>] HostTags data, response status code and response headers def create_host_tags_with_http_info(host_name, body, opts = {}) @@ -108,12 +108,12 @@ def delete_host_tags(host_name, opts = {}) # Remove host tags. # - # 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 host_name [String] This endpoint allows you to remove all user-assigned tags for a single host. + # @param host_name [String] Specified host name to delete tags # @param opts [Hash] the optional parameters - # @option opts [String] :source 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). + # @option opts [String] :source 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. # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def delete_host_tags_with_http_info(host_name, opts = {}) @@ -166,7 +166,7 @@ def delete_host_tags_with_http_info(host_name, opts = {}) return data, status_code, headers end - # Get host tags. + # Get Host Tags. # # @see #get_host_tags_with_http_info def get_host_tags(host_name, opts = {}) @@ -174,13 +174,13 @@ def get_host_tags(host_name, opts = {}) data end - # Get host tags. + # Get Host Tags. # # Return the list of tags that apply to a given host. # - # @param host_name [String] When specified, filters list of tags to those tags with the specified source. + # @param host_name [String] Name of the host to retrieve tags for # @param opts [Hash] the optional parameters - # @option opts [String] :source Source to filter. + # @option opts [String] :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. # @return [Array<(HostTags, Integer, Hash)>] HostTags data, response status code and response headers def get_host_tags_with_http_info(host_name, opts = {}) @@ -233,7 +233,7 @@ def get_host_tags_with_http_info(host_name, opts = {}) return data, status_code, headers end - # Get Tags. + # Get All Host Tags. # # @see #list_host_tags_with_http_info def list_host_tags(opts = {}) @@ -241,12 +241,12 @@ def list_host_tags(opts = {}) data end - # Get Tags. + # Get All Host Tags. # - # 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 opts [Hash] the optional parameters - # @option opts [String] :source When specified, filters host list to those tags with the specified source. + # @option opts [String] :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. # @return [Array<(TagToHosts, Integer, Hash)>] TagToHosts data, response status code and response headers def list_host_tags_with_http_info(opts = {}) @@ -308,10 +308,10 @@ def update_host_tags(host_name, body, opts = {}) # This endpoint allows you to update/replace all tags in # an integration source with those supplied in the request. # - # @param host_name [String] This endpoint allows you to update/replace all in an integration source with those supplied in the request. + # @param host_name [String] Specified host name to change tags # @param body [HostTags] Add tags to host # @param opts [Hash] the optional parameters - # @option opts [String] :source 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) + # @option opts [String] :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. # @return [Array<(HostTags, Integer, Hash)>] HostTags data, response status code and response headers def update_host_tags_with_http_info(host_name, body, opts = {}) diff --git a/lib/datadog_api_client/v1/models/host_tags.rb b/lib/datadog_api_client/v1/models/host_tags.rb index 95e8e40ff23..8758d4725e6 100644 --- a/lib/datadog_api_client/v1/models/host_tags.rb +++ b/lib/datadog_api_client/v1/models/host_tags.rb @@ -17,14 +17,14 @@ require 'time' module DatadogAPIClient::V1 - # Set of tags to associate with your host. + # Host name and an array of its tags class HostTags include BaseGenericModel # Your host name. attr_accessor :host - # A list of tags to apply to the host. + # A list of tags attached to a given host. attr_accessor :tags attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v1/models/tag_to_hosts.rb b/lib/datadog_api_client/v1/models/tag_to_hosts.rb index 1c06c7f7a0c..eb12598a3ae 100644 --- a/lib/datadog_api_client/v1/models/tag_to_hosts.rb +++ b/lib/datadog_api_client/v1/models/tag_to_hosts.rb @@ -17,11 +17,11 @@ require 'time' module DatadogAPIClient::V1 - # 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. class TagToHosts include BaseGenericModel - # A list of tags to apply to the host. + # A mapping of tags to host names attr_accessor :tags attr_accessor :additional_properties