Skip to content

Commit efc22d3

Browse files
api-clients-generation-pipeline[bot]jirikuncarci.datadog-api-spec
authored
Add metrics bulk-config endpoint (#818)
* support empty lookup * Regenerate client from commit cdd703e of spec repo Co-authored-by: Jiri Kuncar <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent aa4cf6d commit efc22d3

25 files changed

+1479
-7
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.2",
7-
"regenerated": "2022-02-14 20:16:50.775696",
8-
"spec_repo_commit": "5d7c376"
7+
"regenerated": "2022-02-15 12:44:12.175938",
8+
"spec_repo_commit": "cdd703e"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.2",
12-
"regenerated": "2022-02-14 20:16:50.787694",
13-
"spec_repo_commit": "5d7c376"
12+
"regenerated": "2022-02-15 12:44:12.189619",
13+
"spec_repo_commit": "cdd703e"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 257 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3458,6 +3458,132 @@ components:
34583458
$ref: '#/components/schemas/MetricAllTags'
34593459
readOnly: true
34603460
type: object
3461+
MetricBulkConfigureTagsType:
3462+
default: metric_bulk_configure_tags
3463+
description: The metric bulk configure tags resource.
3464+
enum:
3465+
- metric_bulk_configure_tags
3466+
example: metric_bulk_configure_tags
3467+
x-enum-varnames:
3468+
- BULK_MANAGE_TAGS
3469+
MetricBulkTagConfigCreate:
3470+
description: Request object to bulk configure tags for metrics matching the
3471+
given prefix.
3472+
properties:
3473+
attributes:
3474+
$ref: '#/components/schemas/MetricBulkTagConfigCreateAttributes'
3475+
id:
3476+
$ref: '#/components/schemas/MetricBulkTagConfigNamePrefix'
3477+
type:
3478+
$ref: '#/components/schemas/MetricBulkConfigureTagsType'
3479+
required:
3480+
- id
3481+
- type
3482+
type: object
3483+
MetricBulkTagConfigCreateAttributes:
3484+
description: Optional parameters for bulk creating metric tag configurations.
3485+
properties:
3486+
emails:
3487+
$ref: '#/components/schemas/MetricBulkTagConfigEmailList'
3488+
tags:
3489+
$ref: '#/components/schemas/MetricBulkTagConfigTagNameList'
3490+
type: object
3491+
MetricBulkTagConfigCreateRequest:
3492+
description: Wrapper object for a single bulk tag configuration request.
3493+
properties:
3494+
data:
3495+
$ref: '#/components/schemas/MetricBulkTagConfigCreate'
3496+
required:
3497+
- data
3498+
type: object
3499+
MetricBulkTagConfigDelete:
3500+
description: Request object to bulk delete all tag configurations for metrics
3501+
matching the given prefix.
3502+
properties:
3503+
attributes:
3504+
$ref: '#/components/schemas/MetricBulkTagConfigDeleteAttributes'
3505+
id:
3506+
$ref: '#/components/schemas/MetricBulkTagConfigNamePrefix'
3507+
type:
3508+
$ref: '#/components/schemas/MetricBulkConfigureTagsType'
3509+
required:
3510+
- id
3511+
- type
3512+
type: object
3513+
MetricBulkTagConfigDeleteAttributes:
3514+
description: Optional parameters for bulk deleting metric tag configurations.
3515+
properties:
3516+
emails:
3517+
$ref: '#/components/schemas/MetricBulkTagConfigEmailList'
3518+
type: object
3519+
MetricBulkTagConfigDeleteRequest:
3520+
description: Wrapper object for a single bulk tag deletion request.
3521+
properties:
3522+
data:
3523+
$ref: '#/components/schemas/MetricBulkTagConfigDelete'
3524+
required:
3525+
- data
3526+
type: object
3527+
MetricBulkTagConfigEmailList:
3528+
description: A list of account emails to notify when the configuration is applied.
3529+
example:
3530+
3531+
3532+
items:
3533+
description: An email address.
3534+
format: email
3535+
type: string
3536+
type: array
3537+
MetricBulkTagConfigNamePrefix:
3538+
description: A text prefix to match against metric names.
3539+
example: kafka.lag
3540+
type: string
3541+
MetricBulkTagConfigResponse:
3542+
description: Wrapper for a single bulk tag configuration status response.
3543+
properties:
3544+
data:
3545+
$ref: '#/components/schemas/MetricBulkTagConfigStatus'
3546+
type: object
3547+
MetricBulkTagConfigStatus:
3548+
description: 'The status of a request to bulk configure metric tags.
3549+
3550+
It contains the fields from the original request for reference.'
3551+
properties:
3552+
attributes:
3553+
$ref: '#/components/schemas/MetricBulkTagConfigStatusAttributes'
3554+
id:
3555+
$ref: '#/components/schemas/MetricBulkTagConfigNamePrefix'
3556+
type:
3557+
$ref: '#/components/schemas/MetricBulkConfigureTagsType'
3558+
required:
3559+
- id
3560+
- type
3561+
type: object
3562+
MetricBulkTagConfigStatusAttributes:
3563+
description: Optional attributes for the status of a bulk tag configuration
3564+
request.
3565+
properties:
3566+
emails:
3567+
$ref: '#/components/schemas/MetricBulkTagConfigEmailList'
3568+
status:
3569+
description: The status of the request.
3570+
example: Accepted
3571+
type: string
3572+
tags:
3573+
$ref: '#/components/schemas/MetricBulkTagConfigTagNameList'
3574+
type: object
3575+
MetricBulkTagConfigTagNameList:
3576+
description: A list of tag names to apply to the configuration.
3577+
example:
3578+
- host
3579+
- pod_name
3580+
- is_shadow
3581+
items:
3582+
description: A metric tag name.
3583+
maxLength: 200
3584+
pattern: ^[A-Za-z][A-Za-z0-9\.\-\_:\/]*$
3585+
type: string
3586+
type: array
34613587
MetricCustomAggregation:
34623588
description: A time and space aggregation combination for use in query.
34633589
example:
@@ -8153,6 +8279,137 @@ paths:
81538279
is only accessible for Metrics without Limits&trade; beta customers.\nIf you\u2019re
81548280
interested in Metrics without Limits&trade;, please contact your Customer
81558281
Success Manager.**"
8282+
/api/v2/metrics/config/bulk-tags:
8283+
delete:
8284+
description: 'Delete all custom lists of queryable tag keys for a set of existing
8285+
count, gauge, rate, and distribution metrics.
8286+
8287+
Metrics are selected by passing a metric name prefix.
8288+
8289+
Results can be sent to a set of account email addresses, just like the same
8290+
operation in the Datadog web app.
8291+
8292+
Can only be used with application keys of users with the `Manage Tags for
8293+
Metrics` permission.'
8294+
operationId: DeleteBulkTagsMetricsConfiguration
8295+
requestBody:
8296+
content:
8297+
application/json:
8298+
schema:
8299+
$ref: '#/components/schemas/MetricBulkTagConfigDeleteRequest'
8300+
required: true
8301+
responses:
8302+
'202':
8303+
content:
8304+
application/json:
8305+
schema:
8306+
$ref: '#/components/schemas/MetricBulkTagConfigResponse'
8307+
description: Accepted
8308+
'400':
8309+
content:
8310+
application/json:
8311+
schema:
8312+
$ref: '#/components/schemas/APIErrorResponse'
8313+
description: Bad Request
8314+
'403':
8315+
content:
8316+
application/json:
8317+
schema:
8318+
$ref: '#/components/schemas/APIErrorResponse'
8319+
description: Forbidden
8320+
'404':
8321+
content:
8322+
application/json:
8323+
schema:
8324+
$ref: '#/components/schemas/APIErrorResponse'
8325+
description: Not Found
8326+
'429':
8327+
content:
8328+
application/json:
8329+
schema:
8330+
$ref: '#/components/schemas/APIErrorResponse'
8331+
description: Too Many Requests
8332+
security:
8333+
- apiKeyAuth: []
8334+
appKeyAuth: []
8335+
- AuthZ: []
8336+
summary: Configure tags for multiple metrics
8337+
tags:
8338+
- Metrics
8339+
x-codegen-request-body-name: body
8340+
x-menu-order: 9
8341+
x-undo:
8342+
type: idempotent
8343+
post:
8344+
description: 'Create and define a list of queryable tag keys for a set of existing
8345+
count, gauge, rate, and distribution metrics.
8346+
8347+
Metrics are selected by passing a metric name prefix. Use the Delete method
8348+
of this API path to remove tag configurations.
8349+
8350+
Results can be sent to a set of account email addresses, just like the same
8351+
operation in the Datadog web app.
8352+
8353+
If multiple calls include the same metric, the last configuration applied
8354+
(not by submit order) is used, do not
8355+
8356+
expect deterministic ordering of concurrent calls.
8357+
8358+
Can only be used with application keys of users with the `Manage Tags for
8359+
Metrics` permission.'
8360+
operationId: CreateBulkTagsMetricsConfiguration
8361+
requestBody:
8362+
content:
8363+
application/json:
8364+
schema:
8365+
$ref: '#/components/schemas/MetricBulkTagConfigCreateRequest'
8366+
required: true
8367+
responses:
8368+
'202':
8369+
content:
8370+
application/json:
8371+
schema:
8372+
$ref: '#/components/schemas/MetricBulkTagConfigResponse'
8373+
description: Accepted
8374+
'400':
8375+
content:
8376+
application/json:
8377+
schema:
8378+
$ref: '#/components/schemas/APIErrorResponse'
8379+
description: Bad Request
8380+
'403':
8381+
content:
8382+
application/json:
8383+
schema:
8384+
$ref: '#/components/schemas/APIErrorResponse'
8385+
description: Forbidden
8386+
'404':
8387+
content:
8388+
application/json:
8389+
schema:
8390+
$ref: '#/components/schemas/APIErrorResponse'
8391+
description: Not Found
8392+
'429':
8393+
content:
8394+
application/json:
8395+
schema:
8396+
$ref: '#/components/schemas/APIErrorResponse'
8397+
description: Too Many Requests
8398+
security:
8399+
- apiKeyAuth: []
8400+
appKeyAuth: []
8401+
- AuthZ: []
8402+
summary: Configure tags for multiple metrics
8403+
tags:
8404+
- Metrics
8405+
x-codegen-request-body-name: body
8406+
x-menu-order: 8
8407+
x-undo:
8408+
operationId: DeleteBulkTagsMetricsConfiguration
8409+
parameters:
8410+
- name: body
8411+
source: ''
8412+
type: unsafe
81568413
/api/v2/metrics/{metric_name}/all-tags:
81578414
get:
81588415
description: View indexed tag key-value pairs for a given metric name.

docs/datadog_api_client.v2.model.rst

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1673,6 +1673,102 @@ metric\_all\_tags\_response
16731673
:undoc-members:
16741674
:show-inheritance:
16751675

1676+
metric\_bulk\_configure\_tags\_type
1677+
-----------------------------------
1678+
1679+
.. automodule:: datadog_api_client.v2.model.metric_bulk_configure_tags_type
1680+
:members:
1681+
:undoc-members:
1682+
:show-inheritance:
1683+
1684+
metric\_bulk\_tag\_config\_create
1685+
---------------------------------
1686+
1687+
.. automodule:: datadog_api_client.v2.model.metric_bulk_tag_config_create
1688+
:members:
1689+
:undoc-members:
1690+
:show-inheritance:
1691+
1692+
metric\_bulk\_tag\_config\_create\_attributes
1693+
---------------------------------------------
1694+
1695+
.. automodule:: datadog_api_client.v2.model.metric_bulk_tag_config_create_attributes
1696+
:members:
1697+
:undoc-members:
1698+
:show-inheritance:
1699+
1700+
metric\_bulk\_tag\_config\_create\_request
1701+
------------------------------------------
1702+
1703+
.. automodule:: datadog_api_client.v2.model.metric_bulk_tag_config_create_request
1704+
:members:
1705+
:undoc-members:
1706+
:show-inheritance:
1707+
1708+
metric\_bulk\_tag\_config\_delete
1709+
---------------------------------
1710+
1711+
.. automodule:: datadog_api_client.v2.model.metric_bulk_tag_config_delete
1712+
:members:
1713+
:undoc-members:
1714+
:show-inheritance:
1715+
1716+
metric\_bulk\_tag\_config\_delete\_attributes
1717+
---------------------------------------------
1718+
1719+
.. automodule:: datadog_api_client.v2.model.metric_bulk_tag_config_delete_attributes
1720+
:members:
1721+
:undoc-members:
1722+
:show-inheritance:
1723+
1724+
metric\_bulk\_tag\_config\_delete\_request
1725+
------------------------------------------
1726+
1727+
.. automodule:: datadog_api_client.v2.model.metric_bulk_tag_config_delete_request
1728+
:members:
1729+
:undoc-members:
1730+
:show-inheritance:
1731+
1732+
metric\_bulk\_tag\_config\_email\_list
1733+
--------------------------------------
1734+
1735+
.. automodule:: datadog_api_client.v2.model.metric_bulk_tag_config_email_list
1736+
:members:
1737+
:undoc-members:
1738+
:show-inheritance:
1739+
1740+
metric\_bulk\_tag\_config\_response
1741+
-----------------------------------
1742+
1743+
.. automodule:: datadog_api_client.v2.model.metric_bulk_tag_config_response
1744+
:members:
1745+
:undoc-members:
1746+
:show-inheritance:
1747+
1748+
metric\_bulk\_tag\_config\_status
1749+
---------------------------------
1750+
1751+
.. automodule:: datadog_api_client.v2.model.metric_bulk_tag_config_status
1752+
:members:
1753+
:undoc-members:
1754+
:show-inheritance:
1755+
1756+
metric\_bulk\_tag\_config\_status\_attributes
1757+
---------------------------------------------
1758+
1759+
.. automodule:: datadog_api_client.v2.model.metric_bulk_tag_config_status_attributes
1760+
:members:
1761+
:undoc-members:
1762+
:show-inheritance:
1763+
1764+
metric\_bulk\_tag\_config\_tag\_name\_list
1765+
------------------------------------------
1766+
1767+
.. automodule:: datadog_api_client.v2.model.metric_bulk_tag_config_tag_name_list
1768+
:members:
1769+
:undoc-members:
1770+
:show-inheritance:
1771+
16761772
metric\_custom\_aggregation
16771773
---------------------------
16781774

0 commit comments

Comments
 (0)