fix: allow time_zone to be specified in web schedules (#2401)

* fix: allow time_zone to be specified in web schedules

* fix: ensure time_zone is read for web schedules

* fix: add example for generated docs

* fix: mark time_zone as computed

Allows the API to correctly set the default value when `time_zone` is
not specified by the user.

* doc: fix typo

* docs: fix typo in grafana_oncall_schedule examples

Upstream fix edited the generated docs files directly.

* fix: fmt terraform example

* docs: generate docs again

---------

Co-authored-by: Stephan Rayner <[email protected]>
Co-authored-by: Jared Welch <[email protected]>

Author: 3 people

docs/resources/oncall_schedule.md

@@ -30,7 +30,7 @@ data "grafana_oncall_team" "my_team" {
 
 // ICal based schedule
 resource "grafana_oncall_schedule" "example_schedule" {
-  name               = "Example Ical Schadule"
+  name               = "Example Ical Schedule"
   type               = "ical"
   ical_url_primary   = "https://example.com/example_ical.ics"
   ical_url_overrides = "https://example.com/example_overrides_ical.ics"
@@ -46,7 +46,7 @@ resource "grafana_oncall_schedule" "example_schedule" {
 
 // Shift based schedule
 resource "grafana_oncall_schedule" "example_schedule" {
-  name      = "Example Calendar Schadule"
+  name      = "Example Calendar Schedule"
   type      = "calendar"
   time_zone = "America/New_York"
 
@@ -57,6 +57,18 @@ resource "grafana_oncall_schedule" "example_schedule" {
   ]
   ical_url_overrides = "https://example.com/example_overrides_ical.ics"
 }
+
+// Web based schedule
+resource "grafana_oncall_schedule" "example_schedule" {
+  name = "Example Web Schedule"
+  type = "web"
+
+  // Optional: defaults to UTC
+  time_zone = "America/New_York"
+
+  // Optional: specify the team to which the schedule belongs
+  team_id = data.grafana_oncall_team.my_team.id
+}
 ```
 
 <!-- schema generated by tfplugindocs -->

examples/resources/grafana_oncall_schedule/resource.tf

@@ -15,7 +15,7 @@ data "grafana_oncall_team" "my_team" {
 
 // ICal based schedule
 resource "grafana_oncall_schedule" "example_schedule" {
-  name               = "Example Ical Schadule"
+  name               = "Example Ical Schedule"
   type               = "ical"
   ical_url_primary   = "https://example.com/example_ical.ics"
   ical_url_overrides = "https://example.com/example_overrides_ical.ics"
@@ -31,7 +31,7 @@ resource "grafana_oncall_schedule" "example_schedule" {
 
 // Shift based schedule
 resource "grafana_oncall_schedule" "example_schedule" {
-  name      = "Example Calendar Schadule"
+  name      = "Example Calendar Schedule"
   type      = "calendar"
   time_zone = "America/New_York"
 
@@ -42,3 +42,15 @@ resource "grafana_oncall_schedule" "example_schedule" {
   ]
   ical_url_overrides = "https://example.com/example_overrides_ical.ics"
 }
+
+// Web based schedule
+resource "grafana_oncall_schedule" "example_schedule" {
+  name = "Example Web Schedule"
+  type = "web"
+
+  // Optional: defaults to UTC
+  time_zone = "America/New_York"
+
+  // Optional: specify the team to which the schedule belongs
+  team_id = data.grafana_oncall_team.my_team.id
+}

internal/resources/oncall/resource_schedule.go

@@ -54,6 +54,7 @@ func resourceSchedule() *common.Resource {
 			"time_zone": {
 				Type:        schema.TypeString,
 				Optional:    true,
+				Computed:    true,
 				Description: "The schedule's time zone.",
 			},
 			"ical_url_primary": {
@@ -173,7 +174,7 @@ func resourceScheduleCreate(ctx context.Context, d *schema.ResourceData, client
 
 	timeZoneData, timeZoneOk := d.GetOk("time_zone")
 	if timeZoneOk {
-		if isScheduleTypeCalendar(typeData) {
+		if isScheduleTypeCalendar(typeData) || isScheduleTypeWeb(typeData) {
 			createOptions.TimeZone = timeZoneData.(string)
 		} else {
 			return diag.Errorf("time_zone can not be set with type: %s", typeData)
@@ -274,6 +275,8 @@ func resourceScheduleRead(ctx context.Context, d *schema.ResourceData, client *o
 	if isScheduleTypeCalendar(schedule.Type) {
 		d.Set("time_zone", schedule.TimeZone)
 		d.Set("shifts", schedule.Shifts)
+	} else if isScheduleTypeWeb(schedule.Type) {
+		d.Set("time_zone", schedule.TimeZone)
 	}
 
 	return nil
@@ -325,3 +328,7 @@ func expandScheduleSlack(in []any) *onCallAPI.SlackSchedule {
 func isScheduleTypeCalendar(t string) bool {
 	return t == "calendar"
 }
+
+func isScheduleTypeWeb(t string) bool {
+	return t == "web"
+}