Add MatchingDowntime to monitor schema and with_downtimes parameter to GetMonitor (#1475)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-23 13:54:25.080716",
-            "spec_repo_commit": "2ccd9d0a"
+            "regenerated": "2023-05-23 19:09:17.970557",
+            "spec_repo_commit": "d1e6ae92"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-23 13:54:25.093595",
-            "spec_repo_commit": "2ccd9d0a"
+            "regenerated": "2023-05-23 19:09:17.983042",
+            "spec_repo_commit": "d1e6ae92"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -5829,6 +5829,43 @@ components:
       type: string
       x-enum-varnames:
       - USER_AGENT_PARSER
+    MatchingDowntime:
+      description: Object describing a downtime that matches this monitor.
+      properties:
+        end:
+          description: POSIX timestamp to end the downtime.
+          example: 1412792983
+          format: int64
+          nullable: true
+          type: integer
+        id:
+          description: The downtime ID.
+          example: 1625
+          format: int64
+          readOnly: true
+          type: integer
+        scope:
+          description: 'The scope(s) to which the downtime applies. Must be in `key:value`
+            format. For example, `host:app2`.
+
+            Provide multiple scopes as a comma-separated list like `env:dev,env:prod`.
+
+            The resulting downtime applies to sources that matches ALL provided scopes
+            (`env:dev` **AND** `env:prod`).'
+          example:
+          - env:staging
+          items:
+            description: A scope. For example, `"env:staging"`.
+            type: string
+          type: array
+        start:
+          description: POSIX timestamp to start the downtime.
+          example: 1412792983
+          format: int64
+          type: integer
+      required:
+      - id
+      type: object
     MetricContentEncoding:
       default: deflate
       description: HTTP header used to compress the media-type.
@@ -6109,6 +6146,11 @@ components:
           format: int64
           readOnly: true
           type: integer
+        matching_downtimes:
+          description: A list of active downtimes that match this monitor.
+          items:
+            $ref: '#/components/schemas/MatchingDowntime'
+          type: array
         message:
           description: A message to include with notifications for this monitor.
           type: string
@@ -25354,6 +25396,13 @@ paths:
         required: false
         schema:
           type: string
+      - description: If this argument is set to true, then the returned data includes
+          all current active downtimes for the monitor.
+        in: query
+        name: with_downtimes
+        required: false
+        schema:
+          type: boolean
       responses:
         '200':
           content:

docs/datadog_api_client.v1.model.rst

@@ -1779,6 +1779,13 @@ logs\_user\_agent\_parser\_type
    :members:
    :show-inheritance:
 
+matching\_downtime
+------------------
+
+.. automodule:: datadog_api_client.v1.model.matching_downtime
+   :members:
+   :show-inheritance:
+
 metric\_content\_encoding
 -------------------------
 

examples/v1/monitors/GetMonitor.py

@@ -14,6 +14,7 @@
     api_instance = MonitorsApi(api_client)
     response = api_instance.get_monitor(
         monitor_id=int(MONITOR_ID),
+        with_downtimes=True,
     )
 
     print(response)

examples/v1/monitors/GetMonitor_2200114573.py

@@ -0,0 +1,20 @@
+"""
+Get a monitor's details with downtime returns "OK" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.monitors_api import MonitorsApi
+
+# there is a valid "monitor" in the system
+MONITOR_ID = environ["MONITOR_ID"]
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = MonitorsApi(api_client)
+    response = api_instance.get_monitor(
+        monitor_id=int(MONITOR_ID),
+        with_downtimes=True,
+    )
+
+    print(response)

src/datadog_api_client/v1/api/monitors_api.py

@@ -131,6 +131,11 @@ def __init__(self, api_client=None):
                     "attribute": "group_states",
                     "location": "query",
                 },
+                "with_downtimes": {
+                    "openapi_types": (bool,),
+                    "attribute": "with_downtimes",
+                    "location": "query",
+                },
             },
             headers_map={
                 "accept": ["application/json"],
@@ -601,6 +606,7 @@ def get_monitor(
         monitor_id: int,
         *,
         group_states: Union[str, UnsetType] = unset,
+        with_downtimes: Union[bool, UnsetType] = unset,
     ) -> Monitor:
         """Get a monitor's details.
 
@@ -610,6 +616,8 @@ def get_monitor(
         :type monitor_id: int
         :param group_states: When specified, shows additional information about the group states. Choose one or more from ``all`` , ``alert`` , ``warn`` , and ``no data``.
         :type group_states: str, optional
+        :param with_downtimes: If this argument is set to true, then the returned data includes all current active downtimes for the monitor.
+        :type with_downtimes: bool, optional
         :rtype: Monitor
         """
         kwargs: Dict[str, Any] = {}
@@ -618,6 +626,9 @@ def get_monitor(
         if group_states is not unset:
             kwargs["group_states"] = group_states
 
+        if with_downtimes is not unset:
+            kwargs["with_downtimes"] = with_downtimes
+
         return self._get_monitor_endpoint.call_with_http_info(**kwargs)
 
     def list_monitors(

src/datadog_api_client/v1/model/matching_downtime.py

@@ -0,0 +1,70 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import List, Union
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    none_type,
+    unset,
+    UnsetType,
+)
+
+
+class MatchingDowntime(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        return {
+            "end": (int, none_type),
+            "id": (int,),
+            "scope": ([str],),
+            "start": (int,),
+        }
+
+    attribute_map = {
+        "end": "end",
+        "id": "id",
+        "scope": "scope",
+        "start": "start",
+    }
+    read_only_vars = {
+        "id",
+    }
+
+    def __init__(
+        self_,
+        id: int,
+        end: Union[int, none_type, UnsetType] = unset,
+        scope: Union[List[str], UnsetType] = unset,
+        start: Union[int, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        Object describing a downtime that matches this monitor.
+
+        :param end: POSIX timestamp to end the downtime.
+        :type end: int, none_type, optional
+
+        :param id: The downtime ID.
+        :type id: int
+
+        :param scope: The scope(s) to which the downtime applies. Must be in ``key:value`` format. For example, ``host:app2``.
+            Provide multiple scopes as a comma-separated list like ``env:dev,env:prod``.
+            The resulting downtime applies to sources that matches ALL provided scopes ( ``env:dev`` **AND** ``env:prod`` ).
+        :type scope: [str], optional
+
+        :param start: POSIX timestamp to start the downtime.
+        :type start: int, optional
+        """
+        if end is not unset:
+            kwargs["end"] = end
+        if scope is not unset:
+            kwargs["scope"] = scope
+        if start is not unset:
+            kwargs["start"] = start
+        super().__init__(kwargs)
+
+        self_.id = id

src/datadog_api_client/v1/model/monitor.py

@@ -17,6 +17,7 @@
 
 if TYPE_CHECKING:
     from datadog_api_client.v1.model.creator import Creator
+    from datadog_api_client.v1.model.matching_downtime import MatchingDowntime
     from datadog_api_client.v1.model.monitor_options import MonitorOptions
     from datadog_api_client.v1.model.monitor_overall_states import MonitorOverallStates
     from datadog_api_client.v1.model.monitor_state import MonitorState
@@ -34,6 +35,7 @@ class Monitor(ModelNormal):
     @cached_property
     def openapi_types(_):
         from datadog_api_client.v1.model.creator import Creator
+        from datadog_api_client.v1.model.matching_downtime import MatchingDowntime
         from datadog_api_client.v1.model.monitor_options import MonitorOptions
         from datadog_api_client.v1.model.monitor_overall_states import MonitorOverallStates
         from datadog_api_client.v1.model.monitor_state import MonitorState
@@ -44,6 +46,7 @@ def openapi_types(_):
             "creator": (Creator,),
             "deleted": (datetime, none_type),
             "id": (int,),
+            "matching_downtimes": ([MatchingDowntime],),
             "message": (str,),
             "modified": (datetime,),
             "multi": (bool,),
@@ -63,6 +66,7 @@ def openapi_types(_):
         "creator": "creator",
         "deleted": "deleted",
         "id": "id",
+        "matching_downtimes": "matching_downtimes",
         "message": "message",
         "modified": "modified",
         "multi": "multi",
@@ -95,6 +99,7 @@ def __init__(
         creator: Union[Creator, UnsetType] = unset,
         deleted: Union[datetime, none_type, UnsetType] = unset,
         id: Union[int, UnsetType] = unset,
+        matching_downtimes: Union[List[MatchingDowntime], UnsetType] = unset,
         message: Union[str, UnsetType] = unset,
         modified: Union[datetime, UnsetType] = unset,
         multi: Union[bool, UnsetType] = unset,
@@ -122,6 +127,9 @@ def __init__(
         :param id: ID of this monitor.
         :type id: int, optional
 
+        :param matching_downtimes: A list of active downtimes that match this monitor.
+        :type matching_downtimes: [MatchingDowntime], optional
+
         :param message: A message to include with notifications for this monitor.
         :type message: str, optional
 
@@ -166,6 +174,8 @@ def __init__(
             kwargs["deleted"] = deleted
         if id is not unset:
             kwargs["id"] = id
+        if matching_downtimes is not unset:
+            kwargs["matching_downtimes"] = matching_downtimes
         if message is not unset:
             kwargs["message"] = message
         if modified is not unset:

src/datadog_api_client/v1/models/__init__.py

@@ -282,6 +282,7 @@
 from datadog_api_client.v1.model.logs_url_parser_type import LogsURLParserType
 from datadog_api_client.v1.model.logs_user_agent_parser import LogsUserAgentParser
 from datadog_api_client.v1.model.logs_user_agent_parser_type import LogsUserAgentParserType
+from datadog_api_client.v1.model.matching_downtime import MatchingDowntime
 from datadog_api_client.v1.model.metric_content_encoding import MetricContentEncoding
 from datadog_api_client.v1.model.metric_metadata import MetricMetadata
 from datadog_api_client.v1.model.metric_search_response import MetricSearchResponse

tests/v1/cassettes/test_scenarios/test_get_a_monitors_details_returns_ok_response.frozen

@@ -1 +1 @@
-2023-01-18T18:37:19.697Z
+2023-05-22T17:02:26.784Z

tests/v1/cassettes/test_scenarios/test_get_a_monitors_details_returns_ok_response.yaml

@@ -1,9 +1,9 @@
 interactions:
 - request:
-    body: '{"message":"some message Notify: @hipchat-channel","name":"Test-Get_a_monitor_s_details_returns_OK_response-1674067039","options":{"enable_logs_sample":true,"escalation_message":"the
+    body: '{"message":"some message Notify: @hipchat-channel","name":"Test-Get_a_monitor_s_details_returns_OK_response-1684774946","options":{"enable_logs_sample":true,"escalation_message":"the
       situation has escalated","evaluation_delay":700,"groupby_simple_monitor":true,"include_tags":true,"locked":false,"new_host_delay":600,"no_data_timeframe":null,"notification_preset_name":"hide_handles","notify_audit":false,"notify_no_data":false,"on_missing_data":"show_and_notify_no_data","renotify_interval":60,"require_full_window":true,"thresholds":{"critical":2,"warning":1},"timeout_h":24},"priority":3,"query":"logs(\"service:foo
       AND type:error\").index(\"main\").rollup(\"count\").by(\"source\").last(\"5m\")
-      > 2","tags":["test:testgetamonitorsdetailsreturnsokresponse1674067039","env:ci"],"type":"log
+      > 2","tags":["test:testgetamonitorsdetailsreturnsokresponse1684774946","env:ci"],"type":"log
       alert"}'
     headers:
       accept:
@@ -14,11 +14,11 @@ interactions:
     uri: https://api.datadoghq.com/api/v1/monitor
   response:
     body:
-      string: '{"id":108260305,"org_id":321813,"type":"log alert","name":"Test-Get_a_monitor_s_details_returns_OK_response-1674067039","message":"some
-        message Notify: @hipchat-channel","tags":["test:testgetamonitorsdetailsreturnsokresponse1674067039","env:ci"],"query":"logs(\"service:foo
+      string: '{"id":119735290,"org_id":321813,"type":"log alert","name":"Test-Get_a_monitor_s_details_returns_OK_response-1684774946","message":"some
+        message Notify: @hipchat-channel","tags":["test:testgetamonitorsdetailsreturnsokresponse1684774946","env:ci"],"query":"logs(\"service:foo
         AND type:error\").index(\"main\").rollup(\"count\").by(\"source\").last(\"5m\")
         > 2","options":{"enable_logs_sample":true,"escalation_message":"the situation
-        has escalated","evaluation_delay":700,"groupby_simple_monitor":true,"include_tags":true,"locked":false,"new_host_delay":600,"no_data_timeframe":null,"notification_preset_name":"hide_handles","notify_audit":false,"notify_no_data":false,"on_missing_data":"show_and_notify_no_data","renotify_interval":60,"require_full_window":true,"thresholds":{"critical":2.0,"warning":1.0},"timeout_h":24,"silenced":{}},"multi":true,"created_at":1674067039000,"created":"2023-01-18T18:37:19.812019+00:00","modified":"2023-01-18T18:37:19.812019+00:00","deleted":null,"restricted_roles":null,"priority":3,"overall_state_modified":null,"overall_state":"No
+        has escalated","evaluation_delay":700,"groupby_simple_monitor":true,"include_tags":true,"locked":false,"new_host_delay":600,"no_data_timeframe":null,"notification_preset_name":"hide_handles","notify_audit":false,"notify_no_data":false,"on_missing_data":"show_and_notify_no_data","renotify_interval":60,"require_full_window":true,"thresholds":{"critical":2.0,"warning":1.0},"timeout_h":24,"silenced":{}},"multi":true,"created_at":1684774946000,"created":"2023-05-22T17:02:26.996650+00:00","modified":"2023-05-22T17:02:26.996650+00:00","deleted":null,"restricted_roles":null,"priority":3,"overall_state_modified":null,"overall_state":"No
         Data","creator":{"name":null,"handle":"[email protected]","email":"[email protected]","id":1445416}}
 
         '
@@ -34,15 +34,15 @@ interactions:
       accept:
       - application/json
     method: GET
-    uri: https://api.datadoghq.com/api/v1/monitor/108260305
+    uri: https://api.datadoghq.com/api/v1/monitor/119735290?with_downtimes=true
   response:
     body:
-      string: '{"id":108260305,"org_id":321813,"type":"log alert","name":"Test-Get_a_monitor_s_details_returns_OK_response-1674067039","message":"some
-        message Notify: @hipchat-channel","tags":["test:testgetamonitorsdetailsreturnsokresponse1674067039","env:ci"],"query":"logs(\"service:foo
+      string: '{"id":119735290,"org_id":321813,"type":"log alert","name":"Test-Get_a_monitor_s_details_returns_OK_response-1684774946","message":"some
+        message Notify: @hipchat-channel","tags":["test:testgetamonitorsdetailsreturnsokresponse1684774946","env:ci"],"query":"logs(\"service:foo
         AND type:error\").index(\"main\").rollup(\"count\").by(\"source\").last(\"5m\")
         > 2","options":{"enable_logs_sample":true,"escalation_message":"the situation
-        has escalated","evaluation_delay":700,"groupby_simple_monitor":true,"include_tags":true,"locked":false,"new_host_delay":600,"no_data_timeframe":null,"notification_preset_name":"hide_handles","notify_audit":false,"notify_no_data":false,"on_missing_data":"show_and_notify_no_data","renotify_interval":60,"require_full_window":true,"thresholds":{"critical":2.0,"warning":1.0},"timeout_h":24,"silenced":{}},"multi":true,"created_at":1674067039000,"created":"2023-01-18T18:37:19.812019+00:00","modified":"2023-01-18T18:37:19.812019+00:00","deleted":null,"restricted_roles":null,"priority":3,"overall_state_modified":null,"overall_state":"No
-        Data","creator":{"name":null,"handle":"[email protected]","email":"[email protected]","id":1445416}}
+        has escalated","evaluation_delay":700,"groupby_simple_monitor":true,"include_tags":true,"locked":false,"new_host_delay":600,"no_data_timeframe":null,"notification_preset_name":"hide_handles","notify_audit":false,"notify_no_data":false,"on_missing_data":"show_and_notify_no_data","renotify_interval":60,"require_full_window":true,"thresholds":{"critical":2.0,"warning":1.0},"timeout_h":24,"silenced":{}},"multi":true,"created_at":1684774946000,"created":"2023-05-22T17:02:26.996650+00:00","modified":"2023-05-22T17:02:26.996650+00:00","deleted":null,"restricted_roles":null,"priority":3,"overall_state_modified":null,"overall_state":"No
+        Data","creator":{"name":null,"handle":"[email protected]","email":"[email protected]","id":1445416},"matching_downtimes":[]}
 
         '
     headers:
@@ -57,10 +57,10 @@ interactions:
       accept:
       - application/json
     method: DELETE
-    uri: https://api.datadoghq.com/api/v1/monitor/108260305
+    uri: https://api.datadoghq.com/api/v1/monitor/119735290
   response:
     body:
-      string: '{"deleted_monitor_id":108260305}
+      string: '{"deleted_monitor_id":119735290}
 
         '
     headers:

tests/v1/cassettes/test_scenarios/test_get_a_monitors_details_with_downtime_returns_ok_response.frozen

@@ -0,0 +1 @@
+2023-05-22T21:15:19.763Z