Merge pull request #216 from mackerelio/notification-group-type

Add notification group type field

Author: mechairoi

notification_groups.go

@@ -14,10 +14,23 @@ const (
 	NotificationLevelCritical NotificationLevel = "critical"
 )
 
+// NotificationGroupType represents a type of notification group.
+type NotificationGroupType string
+
+// NotificationGroupTypes
+const (
+	NotificationGroupTypeGroup        NotificationGroupType = "group"
+	NotificationGroupTypeGroupDefault NotificationGroupType = "group-default"
+)
+
 // NotificationGroup represents a Mackerel notification group.
 // ref. https://mackerel.io/api-docs/entry/notification-groups
 type NotificationGroup struct {
-	ID                        string                      `json:"id,omitempty"`
+	// ID is excluded when used to call CreateNotificationGroup.
+	ID string `json:"id,omitempty"`
+
+	// Type is excluded when used to call CreateNotificationGroup or UpdateNotificationGroup.
+	Type                      NotificationGroupType       `json:"type,omitempty"`
 	Name                      string                      `json:"name"`
 	NotificationLevel         NotificationLevel           `json:"notificationLevel"`
 	ChildNotificationGroupIDs []string                    `json:"childNotificationGroupIds"`

notification_groups_test.go

@@ -29,6 +29,7 @@ func TestCreateNotificationGroup(t *testing.T) {
 
 		respJSON, _ := json.Marshal(map[string]any{
 			"id":                        "3JwREyrZGQ9",
+			"type":                      "group",
 			"name":                      notificationGroup.Name,
 			"notificationLevel":         notificationGroup.NotificationLevel,
 			"childNotificationGroupIds": notificationGroup.ChildNotificationGroupIDs,
@@ -66,6 +67,7 @@ func TestCreateNotificationGroup(t *testing.T) {
 
 	want := &NotificationGroup{
 		ID:                        "3JwREyrZGQ9",
+		Type:                      NotificationGroupTypeGroup,
 		Name:                      param.Name,
 		NotificationLevel:         param.NotificationLevel,
 		ChildNotificationGroupIDs: param.ChildNotificationGroupIDs,
@@ -92,20 +94,23 @@ func TestFindNotificationGroups(t *testing.T) {
 			"notificationGroups": {
 				{
 					"id":                        "3Ja3HG3bTwq",
+					"type":                      "group-default",
 					"name":                      "Default",
 					"notificationLevel":         "all",
 					"childNotificationGroupIDs": []string{},
 					"childChannelIDs":           []string{"3Ja3HG3VTaA"},
 				},
 				{
 					"id":                        "3UJaU9eREvw",
+					"type":                      "group",
 					"name":                      "Notification Group #01",
 					"notificationLevel":         "all",
 					"childNotificationGroupIds": []string{"3Tdq1pz9aLm"},
 					"childChannelIds":           []string{},
 				},
 				{
 					"id":                        "3Tdq1pz9aLm",
+					"type":                      "group",
 					"name":                      "Notification Group #02",
 					"notificationLevel":         "critical",
 					"childNotificationGroupIds": []string{},
@@ -135,20 +140,23 @@ func TestFindNotificationGroups(t *testing.T) {
 	want := []*NotificationGroup{
 		{
 			ID:                        "3Ja3HG3bTwq",
+			Type:                      NotificationGroupTypeGroupDefault,
 			Name:                      "Default",
 			NotificationLevel:         NotificationLevelAll,
 			ChildNotificationGroupIDs: []string{},
 			ChildChannelIDs:           []string{"3Ja3HG3VTaA"},
 		},
 		{
 			ID:                        "3UJaU9eREvw",
+			Type:                      NotificationGroupTypeGroup,
 			Name:                      "Notification Group #01",
 			NotificationLevel:         NotificationLevelAll,
 			ChildNotificationGroupIDs: []string{"3Tdq1pz9aLm"},
 			ChildChannelIDs:           []string{},
 		},
 		{
 			ID:                        "3Tdq1pz9aLm",
+			Type:                      NotificationGroupTypeGroup,
 			Name:                      "Notification Group #02",
 			NotificationLevel:         NotificationLevelCritical,
 			ChildNotificationGroupIDs: []string{},
@@ -186,6 +194,7 @@ func TestUpdateNotificationGroup(t *testing.T) {
 
 		respJSON, _ := json.Marshal(map[string]any{
 			"id":                        id,
+			"type":                      "group",
 			"name":                      notificationGroup.Name,
 			"notificationLevel":         notificationGroup.NotificationLevel,
 			"childNotificationGroupIds": notificationGroup.ChildNotificationGroupIDs,
@@ -223,6 +232,7 @@ func TestUpdateNotificationGroup(t *testing.T) {
 
 	want := &NotificationGroup{
 		ID:                        id,
+		Type:                      NotificationGroupTypeGroup,
 		Name:                      param.Name,
 		NotificationLevel:         param.NotificationLevel,
 		ChildNotificationGroupIDs: param.ChildNotificationGroupIDs,
@@ -248,6 +258,7 @@ func TestDeleteNotificationGroup(t *testing.T) {
 
 		respJSON, _ := json.Marshal(map[string]any{
 			"id":                        id,
+			"type":                      "group",
 			"name":                      "My Notification Group",
 			"notificationLevel":         "all",
 			"childNotificationGroupIds": []string{},
@@ -274,6 +285,7 @@ func TestDeleteNotificationGroup(t *testing.T) {
 
 	want := &NotificationGroup{
 		ID:                        id,
+		Type:                      NotificationGroupTypeGroup,
 		Name:                      "My Notification Group",
 		NotificationLevel:         NotificationLevelAll,
 		ChildNotificationGroupIDs: []string{},