Skip to content

Commit a629757

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
dan.chiniara/url-encoding-for-monitor-api (#519)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent c869985 commit a629757

File tree

6 files changed

+24
-11
lines changed

6 files changed

+24
-11
lines changed

.apigentools-info

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-03-17 17:20:24.489632",
8-
"spec_repo_commit": "29344bf2"
7+
"regenerated": "2025-03-17 21:06:22.556141",
8+
"spec_repo_commit": "2dfddc18"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-03-17 17:20:24.506769",
13-
"spec_repo_commit": "29344bf2"
12+
"regenerated": "2025-03-17 21:06:22.571637",
13+
"spec_repo_commit": "2dfddc18"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

+9-3
Original file line numberDiff line numberDiff line change
@@ -29328,7 +29328,7 @@ paths:
2932829328
- description: 'When specified, shows additional information about the group
2932929329
states.
2933029330

29331-
Choose one or more from `all`, `alert`, `warn`, and `no data` (`no%20data`).'
29331+
Choose one or more from `all`, `alert`, `warn`, and `no data`.'
2933229332
in: query
2933329333
name: group_states
2933429334
required: false
@@ -36863,7 +36863,10 @@ tags:
3686336863

3686436864
scopes from alerting. Downtime settings, which can be scheduled with start and
3686536865

36866-
end times, prevent all alerting related to specified Datadog tags.'
36866+
end times, prevent all alerting related to specified Datadog tags.
36867+
36868+
36869+
**Note:** `curl` commands require [url encoding](https://curl.se/docs/url-syntax.html).'
3686736870
name: Downtimes
3686836871
- description: 'The Event Management API allows you to programmatically post events
3686936872
to the Events Explorer and fetch events from the Events Explorer. See the [Event
@@ -36940,7 +36943,10 @@ tags:
3694036943
notifies your team when a defined threshold has exceeded.
3694136944

3694236945

36943-
For more information, see [Creating Monitors](https://docs.datadoghq.com/monitors/create/types/).'
36946+
For more information, see [Creating Monitors](https://docs.datadoghq.com/monitors/create/types/).
36947+
36948+
36949+
**Note:** `curl` commands require [url encoding](https://curl.se/docs/url-syntax.html).'
3694436950
externalDocs:
3694536951
description: Find out more at
3694636952
url: https://docs.datadoghq.com/monitors/create/types/

src/datadogV1/api/api_downtimes.rs

+2
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ pub enum UpdateDowntimeError {
9393
/// you greater control over monitor notifications by allowing you to globally exclude
9494
/// scopes from alerting. Downtime settings, which can be scheduled with start and
9595
/// end times, prevent all alerting related to specified Datadog tags.
96+
///
97+
/// **Note:** `curl` commands require [url encoding](<https://curl.se/docs/url-syntax.html>).
9698
#[derive(Debug, Clone)]
9799
pub struct DowntimesAPI {
98100
config: datadog::Configuration,

src/datadogV1/api/api_monitors.rs

+4-2
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ impl GetMonitorOptionalParams {
5656
#[derive(Clone, Default, Debug)]
5757
pub struct ListMonitorsOptionalParams {
5858
/// When specified, shows additional information about the group states.
59-
/// Choose one or more from `all`, `alert`, `warn`, and `no data` (`no%20data`).
59+
/// Choose one or more from `all`, `alert`, `warn`, and `no data`.
6060
pub group_states: Option<String>,
6161
/// A string to filter monitors by name.
6262
pub name: Option<String>,
@@ -78,7 +78,7 @@ pub struct ListMonitorsOptionalParams {
7878

7979
impl ListMonitorsOptionalParams {
8080
/// When specified, shows additional information about the group states.
81-
/// Choose one or more from `all`, `alert`, `warn`, and `no data` (`no%20data`).
81+
/// Choose one or more from `all`, `alert`, `warn`, and `no data`.
8282
pub fn group_states(mut self, value: String) -> Self {
8383
self.group_states = Some(value);
8484
self
@@ -323,6 +323,8 @@ pub enum ValidateMonitorError {
323323
/// notifies your team when a defined threshold has exceeded.
324324
///
325325
/// For more information, see [Creating Monitors](<https://docs.datadoghq.com/monitors/create/types/>).
326+
///
327+
/// **Note:** `curl` commands require [url encoding](<https://curl.se/docs/url-syntax.html>).
326328
#[derive(Debug, Clone)]
327329
pub struct MonitorsAPI {
328330
config: datadog::Configuration,

tests/scenarios/features/v1/downtimes.feature

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Feature: Downtimes
44
you greater control over monitor notifications by allowing you to globally
55
exclude scopes from alerting. Downtime settings, which can be scheduled
66
with start and end times, prevent all alerting related to specified
7-
Datadog tags.
7+
Datadog tags. **Note:** `curl` commands require [url
8+
encoding](https://curl.se/docs/url-syntax.html).
89

910
Background:
1011
Given a valid "apiKeyAuth" key in the system

tests/scenarios/features/v1/monitors.feature

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ Feature: Monitors
33
[Monitors](https://docs.datadoghq.com/monitors) allow you to watch a
44
metric or check that you care about and notifies your team when a defined
55
threshold has exceeded. For more information, see [Creating
6-
Monitors](https://docs.datadoghq.com/monitors/create/types/).
6+
Monitors](https://docs.datadoghq.com/monitors/create/types/). **Note:**
7+
`curl` commands require [url encoding](https://curl.se/docs/url-
8+
syntax.html).
79

810
Background:
911
Given a valid "apiKeyAuth" key in the system

0 commit comments

Comments
 (0)