Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor edits to service resource's scheduled_actions block #360

Merged
merged 2 commits into from
Sep 1, 2021
+4 −1
Merged

Minor edits to service resource's scheduled_actions block #360

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e56805
Minor edits to service resource's scheduled_actions block
katkasian Jul 25, 2021
f267088
Edits scheduled_actions block part of service resource documentation
katkasian Aug 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion website/docs/r/service.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The block contains the following arguments:
* `start_time` - The support hours' starting time of day.
* `end_time` - The support hours' ending time of day.

When using `type = "use_support_hours"` in `incident_urgency_rule` you must specify at least one (otherwise optional) `scheduled_actions` block.
When using `type = "use_support_hours"` in `incident_urgency_rule` you can specify an optional `scheduled_actions` block.
Copy link
Contributor

@stmcallister stmcallister Aug 2, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on the information I received from PagerDuty Engineering, the new language should be something more like,

A scheduled_actions block is required when using type = "use_support_hours" in incident_urgency_rule.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @stmcallister ! Reflected your comment.

The block contains the following arguments:

* `type` - The type of scheduled action. Currently, this must be set to `urgency_change`.
Expand All @@ -98,6 +98,8 @@ The `at` block contains the following arguments:
* `type` - The type of time specification. Currently, this must be set to `named_time`.
* `name` - Designates either the start or the end of the scheduled action. Can be `support_hours_start` or `support_hours_end`.

Note that it is currently only possible to define the scheduled action when urgency is set to `high` for `during_support_hours` and to `low` for `outside_support_hours` in `incident_urgency_rule`.

Below is an example for a `pagerduty_service` resource with `incident_urgency_rules` with `type = "use_support_hours"`, `support_hours` and a default `scheduled_action` as well.

```hcl
Expand Down