From 26cc04439055011b425e565ecb279bc785289d5d Mon Sep 17 00:00:00 2001 From: Yulya Artyukhina Date: Fri, 25 Aug 2023 07:59:20 +0200 Subject: [PATCH] Correct escalation policies public api documentation (#2830) # What this PR does Corrects escalation_policies public api docs ## Which issue(s) this PR fixes https://github.com/grafana/oncall/issues/2746 ## Checklist - [x] Unit, integration, and e2e (if applicable) tests updated - [x] Documentation added (or `pr:no public docs` PR label added if not required) - [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not required) --------- Co-authored-by: Joey Orlando --- CHANGELOG.md | 4 ++++ docs/sources/oncall-api-reference/escalation_policies.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 77b3f243..b1fc8778 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Enable shifts export endpoint for all schedule types ([#2863](https://github.com/grafana/oncall/pull/2863)) - Use priority field to track primary/overrides calendar in schedule iCal export ([#2871](https://github.com/grafana/oncall/pull/2871)) +### Fixed + +- Fix public api docs for escalation policies by @Ferril ([#2830](https://github.com/grafana/oncall/pull/2830)) + ## v1.3.26 (2023-08-22) ### Changed diff --git a/docs/sources/oncall-api-reference/escalation_policies.md b/docs/sources/oncall-api-reference/escalation_policies.md index c13e1fee..2188ec0c 100644 --- a/docs/sources/oncall-api-reference/escalation_policies.md +++ b/docs/sources/oncall-api-reference/escalation_policies.md @@ -35,8 +35,8 @@ The above command returns JSON structured in the following way: | `escalation_chain_id` | Yes | Each escalation policy is assigned to a specific escalation chain. | | `position` | Optional | Escalation policies execute one after another starting from `position=0`. `Position=-1` will put the escalation policy to the end of the list. A new escalation policy created with a position of an existing escalation policy will move the old one (and all following) down in the list. | | `type` | Yes | One of: `wait`, `notify_persons`, `notify_person_next_each_time`, `notify_on_call_from_schedule`, `notify_user_group`, `trigger_action`, `resolve`, `notify_whole_channel`, `notify_if_time_from_to`. | -| `duration` | Optional | The duration, in seconds, when type `wait` is chosen. | | `important` | Optional | Default is `false`. Will assign "important" to personal notification rules if `true`. This can be used to distinguish alerts on which you want to be notified immediately by phone. Applicable for types `notify_persons`, `notify_on_call_from_schedule`, and `notify_user_group`. | +| `duration` | If type = `wait` | The duration, in seconds, when type `wait` is chosen. Valid values are: `60`, `300`, `900`, `1800`, `3600`. | | `action_to_trigger` | If type = `trigger_action` | ID of an action, or webhook. | | `group_to_notify` | If type = `notify_user_group` | ID of a `User Group`. | | `persons_to_notify` | If type = `notify_persons` | List of user IDs. |