Skip to content
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.

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

Sync OpenAPI specification for (spec-v1-monitor.yaml) #2447

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-03-17 17:20:24.454374",
"spec_repo_commit": "29344bf2"
"regenerated": "2025-03-18 00:13:53.905784",
"spec_repo_commit": "2738500d"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-03-17 17:20:24.469287",
"spec_repo_commit": "29344bf2"
"regenerated": "2025-03-18 00:13:53.920848",
"spec_repo_commit": "2738500d"
}
}
}
20 changes: 13 additions & 7 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29328,7 +29328,7 @@ paths:
- description: 'When specified, shows additional information about the group
states.

Choose one or more from `all`, `alert`, `warn`, and `no data` (`no%20data`).'
Choose one or more from `all`, `alert`, `warn`, and `no data`.'
in: query
name: group_states
required: false
Expand Down Expand Up @@ -29913,15 +29913,15 @@ paths:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- monitors_write
- monitors_read
summary: Validate a monitor
tags:
- Monitors
x-codegen-request-body-name: body
x-permission:
operator: OR
permissions:
- monitors_write
- monitors_read
/api/v1/monitor/{monitor_id}:
delete:
description: Delete the specified monitor
Expand Down Expand Up @@ -30214,15 +30214,15 @@ paths:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- monitors_write
- monitors_read
summary: Validate an existing monitor
tags:
- Monitors
x-codegen-request-body-name: body
x-permission:
operator: OR
permissions:
- monitors_write
- monitors_read
/api/v1/monthly_custom_reports:
get:
deprecated: true
Expand Down Expand Up @@ -36863,7 +36863,10 @@ tags:

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

end times, prevent all alerting related to specified Datadog tags.'
end times, prevent all alerting related to specified Datadog tags.


**Note:** `curl` commands require [url encoding](https://curl.se/docs/url-syntax.html).'
name: Downtimes
- description: 'The Event Management API allows you to programmatically post events
to the Events Explorer and fetch events from the Events Explorer. See the [Event
Expand Down Expand Up @@ -36940,7 +36943,10 @@ tags:
notifies your team when a defined threshold has exceeded.


For more information, see [Creating Monitors](https://docs.datadoghq.com/monitors/create/types/).'
For more information, see [Creating Monitors](https://docs.datadoghq.com/monitors/create/types/).


**Note:** `curl` commands require [url encoding](https://curl.se/docs/url-syntax.html).'
externalDocs:
description: Find out more at
url: https://docs.datadoghq.com/monitors/create/types/
Expand Down
2 changes: 2 additions & 0 deletions src/datadog_api_client/v1/api/downtimes_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ class DowntimesApi:
you greater control over monitor notifications by allowing you to globally exclude
scopes from alerting. Downtime settings, which can be scheduled with start and
end times, prevent all alerting related to specified Datadog tags.

**Note:** ``curl`` commands require `url encoding <https://curl.se/docs/url-syntax.html>`_.
"""

def __init__(self, api_client=None):
Expand Down
6 changes: 4 additions & 2 deletions src/datadog_api_client/v1/api/monitors_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ class MonitorsApi:
notifies your team when a defined threshold has exceeded.

For more information, see `Creating Monitors <https://docs.datadoghq.com/monitors/create/types/>`_.

**Note:** ``curl`` commands require `url encoding <https://curl.se/docs/url-syntax.html>`_.
"""

def __init__(self, api_client=None):
Expand Down Expand Up @@ -679,7 +681,7 @@ def list_monitors(
Get all monitors from your organization.

:param group_states: When specified, shows additional information about the group states.
Choose one or more from ``all`` , ``alert`` , ``warn`` , and ``no data`` ( ``no%20data`` ).
Choose one or more from ``all`` , ``alert`` , ``warn`` , and ``no data``.
:type group_states: str, optional
:param name: A string to filter monitors by name.
:type name: str, optional
Expand Down Expand Up @@ -743,7 +745,7 @@ def list_monitors_with_pagination(
Provide a paginated version of :meth:`list_monitors`, returning all items.

:param group_states: When specified, shows additional information about the group states.
Choose one or more from ``all`` , ``alert`` , ``warn`` , and ``no data`` ( ``no%20data`` ).
Choose one or more from ``all`` , ``alert`` , ``warn`` , and ``no data``.
:type group_states: str, optional
:param name: A string to filter monitors by name.
:type name: str, optional
Expand Down
3 changes: 2 additions & 1 deletion tests/v1/features/downtimes.feature
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ Feature: Downtimes
you greater control over monitor notifications by allowing you to globally
exclude scopes from alerting. Downtime settings, which can be scheduled
with start and end times, prevent all alerting related to specified
Datadog tags.
Datadog tags. **Note:** `curl` commands require [url
encoding](https://curl.se/docs/url-syntax.html).

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
4 changes: 3 additions & 1 deletion tests/v1/features/monitors.feature
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ Feature: Monitors
[Monitors](https://docs.datadoghq.com/monitors) allow you to watch a
metric or check that you care about and notifies your team when a defined
threshold has exceeded. For more information, see [Creating
Monitors](https://docs.datadoghq.com/monitors/create/types/).
Monitors](https://docs.datadoghq.com/monitors/create/types/). **Note:**
`curl` commands require [url encoding](https://curl.se/docs/url-
syntax.html).

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down