Add filter.scope to Monitor Notification Rules (DataDog#3462)

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

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

.generator/schemas/v2/openapi.yaml

@@ -32691,15 +32691,23 @@ components:
       properties:
         recipients:
           $ref: '#/components/schemas/MonitorNotificationRuleRecipients'
+          description: A list of recipients to notify. Uses the same format as the
+            monitor `message` field. Must not start with an '@'.
         scope:
-          $ref: '#/components/schemas/MonitorNotificationRuleScope'
+          $ref: '#/components/schemas/MonitorNotificationRuleConditionScope'
       required:
       - scope
       - recipients
       type: object
+    MonitorNotificationRuleConditionScope:
+      description: The scope to which the monitor applied.
+      example: transition_type:alert
+      maxLength: 3000
+      minLength: 1
+      type: string
     MonitorNotificationRuleConditionalRecipients:
       description: Use conditional recipients to define different recipients for different
-        situations.
+        situations. Cannot be used with `recipients`.
       properties:
         conditions:
           description: Conditions of the notification rule.
@@ -32749,12 +32757,30 @@ components:
       description: Filter used to associate the notification rule with monitors.
       oneOf:
       - $ref: '#/components/schemas/MonitorNotificationRuleFilterTags'
+      - $ref: '#/components/schemas/MonitorNotificationRuleFilterScope'
+    MonitorNotificationRuleFilterScope:
+      additionalProperties: false
+      description: Filter monitor notifications. A monitor notification must match
+        the scope.
+      properties:
+        scope:
+          description: A scope composed of one or several key:value pairs, which can
+            be used to filter monitor notifications on monitor and group tags.
+          example: service:(foo OR bar) AND team:test NOT environment:staging
+          maxLength: 3000
+          minLength: 1
+          type: string
+      required:
+      - scope
+      type: object
     MonitorNotificationRuleFilterTags:
       additionalProperties: false
-      description: Filter monitors by tags. Monitors must match all tags.
+      description: Filter monitor notifications by tags. A monitor notification must
+        match all tags.
       properties:
         tags:
-          description: A list of monitor tags.
+          description: A list of tags (key:value pairs), which can be used to filter
+            monitor notifications on monitor and group tags.
           example:
           - team:product
           - host:abc
@@ -32794,7 +32820,7 @@ components:
       type: string
     MonitorNotificationRuleRecipients:
       description: A list of recipients to notify. Uses the same format as the monitor
-        `message` field. Must not start with an '@'.
+        `message` field. Must not start with an '@'. Cannot be used with `conditional_recipients`.
       example:
       - slack-test-channel
       - jira-test
@@ -32877,12 +32903,6 @@ components:
       description: An object related to a monitor notification rule.
       oneOf:
       - $ref: '#/components/schemas/User'
-    MonitorNotificationRuleScope:
-      description: The scope to which the monitor applied.
-      example: transition_type:alert
-      maxLength: 3000
-      minLength: 1
-      type: string
     MonitorNotificationRuleUpdateRequest:
       description: Request for updating a monitor notification rule.
       properties:

api/datadogV2/model_monitor_notification_rule_attributes.go

@@ -12,13 +12,13 @@ import (
 
 // MonitorNotificationRuleAttributes Attributes of the monitor notification rule.
 type MonitorNotificationRuleAttributes struct {
-	// Use conditional recipients to define different recipients for different situations.
+	// Use conditional recipients to define different recipients for different situations. Cannot be used with `recipients`.
 	ConditionalRecipients *MonitorNotificationRuleConditionalRecipients `json:"conditional_recipients,omitempty"`
 	// Filter used to associate the notification rule with monitors.
 	Filter *MonitorNotificationRuleFilter `json:"filter,omitempty"`
 	// The name of the monitor notification rule.
 	Name string `json:"name"`
-	// A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.
+	// A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'. Cannot be used with `conditional_recipients`.
 	Recipients []string `json:"recipients,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject map[string]interface{} `json:"-"`

api/datadogV2/model_monitor_notification_rule_condition.go

@@ -12,7 +12,7 @@ import (
 
 // MonitorNotificationRuleCondition Conditions for `conditional_recipients`.
 type MonitorNotificationRuleCondition struct {
-	// A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.
+	// A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'. Cannot be used with `conditional_recipients`.
 	Recipients []string `json:"recipients"`
 	// The scope to which the monitor applied.
 	Scope string `json:"scope"`

api/datadogV2/model_monitor_notification_rule_conditional_recipients.go

@@ -10,11 +10,11 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// MonitorNotificationRuleConditionalRecipients Use conditional recipients to define different recipients for different situations.
+// MonitorNotificationRuleConditionalRecipients Use conditional recipients to define different recipients for different situations. Cannot be used with `recipients`.
 type MonitorNotificationRuleConditionalRecipients struct {
 	// Conditions of the notification rule.
 	Conditions []MonitorNotificationRuleCondition `json:"conditions"`
-	// A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.
+	// A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'. Cannot be used with `conditional_recipients`.
 	FallbackRecipients []string `json:"fallback_recipients,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`

api/datadogV2/model_monitor_notification_rule_filter.go

@@ -10,7 +10,8 @@ import (
 
 // MonitorNotificationRuleFilter - Filter used to associate the notification rule with monitors.
 type MonitorNotificationRuleFilter struct {
-	MonitorNotificationRuleFilterTags *MonitorNotificationRuleFilterTags
+	MonitorNotificationRuleFilterTags  *MonitorNotificationRuleFilterTags
+	MonitorNotificationRuleFilterScope *MonitorNotificationRuleFilterScope
 
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject interface{}
@@ -21,6 +22,11 @@ func MonitorNotificationRuleFilterTagsAsMonitorNotificationRuleFilter(v *Monitor
 	return MonitorNotificationRuleFilter{MonitorNotificationRuleFilterTags: v}
 }
 
+// MonitorNotificationRuleFilterScopeAsMonitorNotificationRuleFilter is a convenience function that returns MonitorNotificationRuleFilterScope wrapped in MonitorNotificationRuleFilter.
+func MonitorNotificationRuleFilterScopeAsMonitorNotificationRuleFilter(v *MonitorNotificationRuleFilterScope) MonitorNotificationRuleFilter {
+	return MonitorNotificationRuleFilter{MonitorNotificationRuleFilterScope: v}
+}
+
 // UnmarshalJSON turns data into one of the pointers in the struct.
 func (obj *MonitorNotificationRuleFilter) UnmarshalJSON(data []byte) error {
 	var err error
@@ -42,9 +48,27 @@ func (obj *MonitorNotificationRuleFilter) UnmarshalJSON(data []byte) error {
 		obj.MonitorNotificationRuleFilterTags = nil
 	}
 
+	// try to unmarshal data into MonitorNotificationRuleFilterScope
+	err = datadog.Unmarshal(data, &obj.MonitorNotificationRuleFilterScope)
+	if err == nil {
+		if obj.MonitorNotificationRuleFilterScope != nil && obj.MonitorNotificationRuleFilterScope.UnparsedObject == nil {
+			jsonMonitorNotificationRuleFilterScope, _ := datadog.Marshal(obj.MonitorNotificationRuleFilterScope)
+			if string(jsonMonitorNotificationRuleFilterScope) == "{}" { // empty struct
+				obj.MonitorNotificationRuleFilterScope = nil
+			} else {
+				match++
+			}
+		} else {
+			obj.MonitorNotificationRuleFilterScope = nil
+		}
+	} else {
+		obj.MonitorNotificationRuleFilterScope = nil
+	}
+
 	if match != 1 { // more than 1 match
 		// reset to nil
 		obj.MonitorNotificationRuleFilterTags = nil
+		obj.MonitorNotificationRuleFilterScope = nil
 		return datadog.Unmarshal(data, &obj.UnparsedObject)
 	}
 	return nil // exactly one match
@@ -56,6 +80,10 @@ func (obj MonitorNotificationRuleFilter) MarshalJSON() ([]byte, error) {
 		return datadog.Marshal(&obj.MonitorNotificationRuleFilterTags)
 	}
 
+	if obj.MonitorNotificationRuleFilterScope != nil {
+		return datadog.Marshal(&obj.MonitorNotificationRuleFilterScope)
+	}
+
 	if obj.UnparsedObject != nil {
 		return datadog.Marshal(obj.UnparsedObject)
 	}
@@ -68,6 +96,10 @@ func (obj *MonitorNotificationRuleFilter) GetActualInstance() interface{} {
 		return obj.MonitorNotificationRuleFilterTags
 	}
 
+	if obj.MonitorNotificationRuleFilterScope != nil {
+		return obj.MonitorNotificationRuleFilterScope
+	}
+
 	// all schemas are nil
 	return nil
 }

api/datadogV2/model_monitor_notification_rule_filter_scope.go

@@ -0,0 +1,86 @@
+// 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.
+
+package datadogV2
+
+import (
+	"fmt"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+)
+
+// MonitorNotificationRuleFilterScope Filter monitor notifications. A monitor notification must match the scope.
+type MonitorNotificationRuleFilterScope struct {
+	// A scope composed of one or several key:value pairs, which can be used to filter monitor notifications on monitor and group tags.
+	Scope string `json:"scope"`
+	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
+	UnparsedObject map[string]interface{} `json:"-"`
+}
+
+// NewMonitorNotificationRuleFilterScope instantiates a new MonitorNotificationRuleFilterScope object.
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed.
+func NewMonitorNotificationRuleFilterScope(scope string) *MonitorNotificationRuleFilterScope {
+	this := MonitorNotificationRuleFilterScope{}
+	this.Scope = scope
+	return &this
+}
+
+// NewMonitorNotificationRuleFilterScopeWithDefaults instantiates a new MonitorNotificationRuleFilterScope object.
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set.
+func NewMonitorNotificationRuleFilterScopeWithDefaults() *MonitorNotificationRuleFilterScope {
+	this := MonitorNotificationRuleFilterScope{}
+	return &this
+}
+
+// GetScope returns the Scope field value.
+func (o *MonitorNotificationRuleFilterScope) GetScope() string {
+	if o == nil {
+		var ret string
+		return ret
+	}
+	return o.Scope
+}
+
+// GetScopeOk returns a tuple with the Scope field value
+// and a boolean to check if the value has been set.
+func (o *MonitorNotificationRuleFilterScope) GetScopeOk() (*string, bool) {
+	if o == nil {
+		return nil, false
+	}
+	return &o.Scope, true
+}
+
+// SetScope sets field value.
+func (o *MonitorNotificationRuleFilterScope) SetScope(v string) {
+	o.Scope = v
+}
+
+// MarshalJSON serializes the struct using spec logic.
+func (o MonitorNotificationRuleFilterScope) MarshalJSON() ([]byte, error) {
+	toSerialize := map[string]interface{}{}
+	if o.UnparsedObject != nil {
+		return datadog.Marshal(o.UnparsedObject)
+	}
+	toSerialize["scope"] = o.Scope
+	return datadog.Marshal(toSerialize)
+}
+
+// UnmarshalJSON deserializes the given payload.
+func (o *MonitorNotificationRuleFilterScope) UnmarshalJSON(bytes []byte) (err error) {
+	all := struct {
+		Scope *string `json:"scope"`
+	}{}
+	if err = datadog.Unmarshal(bytes, &all); err != nil {
+		return datadog.Unmarshal(bytes, &o.UnparsedObject)
+	}
+	if all.Scope == nil {
+		return fmt.Errorf("required field scope missing")
+	}
+	o.Scope = *all.Scope
+
+	return nil
+}

api/datadogV2/model_monitor_notification_rule_filter_tags.go

@@ -10,9 +10,9 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// MonitorNotificationRuleFilterTags Filter monitors by tags. Monitors must match all tags.
+// MonitorNotificationRuleFilterTags Filter monitor notifications by tags. A monitor notification must match all tags.
 type MonitorNotificationRuleFilterTags struct {
-	// A list of monitor tags.
+	// A list of tags (key:value pairs), which can be used to filter monitor notifications on monitor and group tags.
 	Tags []string `json:"tags"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject map[string]interface{} `json:"-"`

api/datadogV2/model_monitor_notification_rule_response_attributes.go

@@ -12,7 +12,7 @@ import (
 
 // MonitorNotificationRuleResponseAttributes Attributes of the monitor notification rule.
 type MonitorNotificationRuleResponseAttributes struct {
-	// Use conditional recipients to define different recipients for different situations.
+	// Use conditional recipients to define different recipients for different situations. Cannot be used with `recipients`.
 	ConditionalRecipients *MonitorNotificationRuleConditionalRecipients `json:"conditional_recipients,omitempty"`
 	// Creation time of the monitor notification rule.
 	Created *time.Time `json:"created,omitempty"`
@@ -22,7 +22,7 @@ type MonitorNotificationRuleResponseAttributes struct {
 	Modified *time.Time `json:"modified,omitempty"`
 	// The name of the monitor notification rule.
 	Name *string `json:"name,omitempty"`
-	// A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.
+	// A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'. Cannot be used with `conditional_recipients`.
 	Recipients []string `json:"recipients,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`

examples/v2/monitors/CreateMonitorNotificationRule_1379932371.go

@@ -0,0 +1,45 @@
+// Create a monitor notification rule with scope returns "OK" response
+
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"os"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
+)
+
+func main() {
+	body := datadogV2.MonitorNotificationRuleCreateRequest{
+		Data: datadogV2.MonitorNotificationRuleCreateRequestData{
+			Attributes: datadogV2.MonitorNotificationRuleAttributes{
+				Filter: &datadogV2.MonitorNotificationRuleFilter{
+					MonitorNotificationRuleFilterScope: &datadogV2.MonitorNotificationRuleFilterScope{
+						Scope: "test:example-monitor",
+					}},
+				Name: "test rule",
+				Recipients: []string{
+					"slack-test-channel",
+					"jira-test",
+				},
+			},
+			Type: datadogV2.MONITORNOTIFICATIONRULERESOURCETYPE_MONITOR_NOTIFICATION_RULE.Ptr(),
+		},
+	}
+	ctx := datadog.NewDefaultContext(context.Background())
+	configuration := datadog.NewConfiguration()
+	apiClient := datadog.NewAPIClient(configuration)
+	api := datadogV2.NewMonitorsApi(apiClient)
+	resp, r, err := api.CreateMonitorNotificationRule(ctx, body)
+
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Error when calling `MonitorsApi.CreateMonitorNotificationRule`: %v\n", err)
+		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
+	}
+
+	responseContent, _ := json.MarshalIndent(resp, "", "  ")
+	fmt.Fprintf(os.Stdout, "Response from `MonitorsApi.CreateMonitorNotificationRule`:\n%s\n", responseContent)
+}