Skip to content

Deprecate bulk tag config API endpoints #3471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
+18 −0
Open

Deprecate bulk tag config API endpoints #3471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140826,7 +140826,10 @@ paths:
- metrics_read
/api/v2/metrics/config/bulk-tags:
delete:
deprecated: true
description: |-
**Note**: This endpoint is deprecated. Use the `/api/v2/metrics/{metric_name}/tags` endpoint instead.

Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
Metrics are selected by passing a metric name prefix.
Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
Expand Down Expand Up @@ -140897,8 +140900,12 @@ paths:
operator: OR
permissions:
- metric_tags_write
x-sunset: "2027-01-01"
post:
deprecated: true
description: |-
**Note**: This endpoint is deprecated. Use the `/api/v2/metrics/{metric_name}/tags` endpoint instead.

Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
Metrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations.
Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
Expand Down Expand Up @@ -140977,6 +140984,7 @@ paths:
operator: OR
permissions:
- metric_tags_write
x-sunset: "2027-01-01"
/api/v2/metrics/tag-indexing-rules:
get:
description: List tag indexing rules for an org, sorted by `rule_order`, with offset/limit pagination.
Expand Down
10 changes: 10 additions & 0 deletions lib/datadog_api_client/v2/api/metrics_api.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ def create_bulk_tags_metrics_configuration(body, opts = {})

# Configure tags for multiple metrics.
#
# **Note**: This endpoint is deprecated. Use the `/api/v2/metrics/{metric_name}/tags` endpoint instead.
#
# Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
# Metrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations.
# Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
Expand All @@ -41,10 +43,13 @@ def create_bulk_tags_metrics_configuration(body, opts = {})
# the same exclusion state, metric tag configurations do not support mixed inclusion and exclusion for tags on the same metric.
# Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
#
# @deprecated This API is deprecated.
#
# @param body [MetricBulkTagConfigCreateRequest]
# @param opts [Hash] the optional parameters
# @return [Array<(MetricBulkTagConfigResponse, Integer, Hash)>] MetricBulkTagConfigResponse data, response status code and response headers
def create_bulk_tags_metrics_configuration_with_http_info(body, opts = {})
warn "[DEPRECATION] `CreateBulkTagsMetricsConfiguration` is deprecated."

if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: MetricsAPI.create_bulk_tags_metrics_configuration ...'
Expand Down Expand Up @@ -324,15 +329,20 @@ def delete_bulk_tags_metrics_configuration(body, opts = {})

# Delete tags for multiple metrics.
#
# **Note**: This endpoint is deprecated. Use the `/api/v2/metrics/{metric_name}/tags` endpoint instead.
#
# Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
# Metrics are selected by passing a metric name prefix.
# Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
# Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
#
# @deprecated This API is deprecated.
#
# @param body [MetricBulkTagConfigDeleteRequest]
# @param opts [Hash] the optional parameters
# @return [Array<(MetricBulkTagConfigResponse, Integer, Hash)>] MetricBulkTagConfigResponse data, response status code and response headers
def delete_bulk_tags_metrics_configuration_with_http_info(body, opts = {})
warn "[DEPRECATION] `DeleteBulkTagsMetricsConfiguration` is deprecated."

if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: MetricsAPI.delete_bulk_tags_metrics_configuration ...'
Expand Down
Loading