Skip to content

Deprecate bulk tag config API endpoints #3671

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
+17 −2
Open

Deprecate bulk tag config API endpoints #3671

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
11 changes: 9 additions & 2 deletions src/datadog_api_client/v2/api/metrics_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

import collections
from typing import Any, Dict, Union
import warnings

from datadog_api_client.api_client import ApiClient, Endpoint as _Endpoint
from datadog_api_client.configuration import Configuration
Expand Down Expand Up @@ -822,7 +823,9 @@ def create_bulk_tags_metrics_configuration(
self,
body: MetricBulkTagConfigCreateRequest,
) -> MetricBulkTagConfigResponse:
"""Configure tags for multiple metrics.
"""Configure tags for multiple metrics. **Deprecated**.

**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.
Expand All @@ -838,6 +841,7 @@ def create_bulk_tags_metrics_configuration(
kwargs: Dict[str, Any] = {}
kwargs["body"] = body

warnings.warn("create_bulk_tags_metrics_configuration is deprecated", DeprecationWarning, stacklevel=2)
return self._create_bulk_tags_metrics_configuration_endpoint.call_with_http_info(**kwargs)

def create_tag_configuration(
Expand Down Expand Up @@ -909,7 +913,9 @@ def delete_bulk_tags_metrics_configuration(
self,
body: MetricBulkTagConfigDeleteRequest,
) -> MetricBulkTagConfigResponse:
"""Delete tags for multiple metrics.
"""Delete tags for multiple metrics. **Deprecated**.

**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.
Expand All @@ -922,6 +928,7 @@ def delete_bulk_tags_metrics_configuration(
kwargs: Dict[str, Any] = {}
kwargs["body"] = body

warnings.warn("delete_bulk_tags_metrics_configuration is deprecated", DeprecationWarning, stacklevel=2)
return self._delete_bulk_tags_metrics_configuration_endpoint.call_with_http_info(**kwargs)

def delete_tag_configuration(
Expand Down
Loading