Minor update to schedules API docs (#3488)

grafana · Dec 4, 2023 · b73da8e · b73da8e
1 parent 45200c3
commit b73da8e
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/docs/sources/oncall-api-reference/schedules.md b/docs/sources/oncall-api-reference/schedules.md
@@ -42,9 +42,9 @@ The above command returns JSON structured in the following way:
 | Parameter            | Unique |     Required     | Description                                                                                                                                                                                                                                         |
 | -------------------- | :----: | :--------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `name`               |  Yes   |       Yes        | Schedule name.                                                                                                                                                                                                                                      |
-| `type`               |   No   |       Yes        | Schedule type. May be `ical` (used for iCalendar integration) or `calendar` (used for manually created on-call shifts).                                                                                                                             |
+| `type`               |   No   |       Yes        | Schedule type. May be `ical` (used for iCalendar integration),  `calendar` (used for manually created on-call shifts) or `web` (for web UI managed schedules).                                                                                                                             |
 | `team_id`            |   No   |        No        | ID of the team.                                                                                                                                                                                                                                     |
-| `time_zone`          |   No   |     Optional     | Schedule time zone. Is used for manually added on-call shifts in Schedules with type `calendar`. Default time zone is `UTC`. For more information about time zones, see [time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). |
+| `time_zone`          |   No   |       Yes     | Schedule time zone. It is used for manually added on-call shifts in Schedules with type `calendar`. Default time zone is `UTC`. For more information about time zones, see [time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Not used for schedules with type `ical`. |
 | `ical_url_primary`   |   No   | If type = `ical` | URL of external iCal calendar for schedule with type `ical`.                                                                                                                                                                                        |
 | `ical_url_overrides` |   No   |     Optional     | URL of external iCal calendar for schedule with any type. Events from this calendar override events from primary calendar or from on-call shifts.                                                                                                   |
 | `enable_web_overrides` |   No   |     Optional     | Whether to enable web overrides or not. Setting specific for API/Terraform based schedules (`calendar` type).                                                                                                   |