Skip to content

Commit

Permalink
Merge pull request PagerDuty#369 from miketoth/master
Browse files Browse the repository at this point in the history
Update documentation references
  • Loading branch information
Scott McAllister authored Aug 14, 2021
2 parents 273f040 + a615438 commit 298fc33
Show file tree
Hide file tree
Showing 20 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion website/docs/d/escalation_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ The following arguments are supported:
* `id` - The ID of the found escalation policy.
* `name` - The short name of the found escalation policy.

[1]: https://v2.developer.pagerduty.com/v2/page/api-reference#!/Escalation_Policies/get_escalation_policies
[1]: https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1escalation_policies/get
2 changes: 1 addition & 1 deletion website/docs/d/schedule.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ The following arguments are supported:
* `id` - The ID of the found schedule.
* `name` - The short name of the found schedule.

[1]: https://v2.developer.pagerduty.com/v2/page/api-reference#!/Schedules/get_schedules
[1]: https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1schedules~1%7Bid%7D/get
2 changes: 1 addition & 1 deletion website/docs/d/user.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ The following arguments are supported:
* `id` - The ID of the found user.
* `name` - The short name of the found user.

[1]: https://v2.developer.pagerduty.com/v2/page/api-reference#!/Users/get_users
[1]: https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1users/get
2 changes: 1 addition & 1 deletion website/docs/d/vendor.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ The following arguments are supported:
* `name` - The short name of the found vendor.
* `type` - The generic service type for this vendor.

[1]: https://v2.developer.pagerduty.com/v2/page/api-reference#!/Vendors/get_vendors
[1]: https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1vendors/get
2 changes: 1 addition & 1 deletion website/docs/index.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@ resource "pagerduty_user" "earline" {

The following arguments are supported:

* `token` - (Required) The v2 authorization token. It can also be sourced from the PAGERDUTY_TOKEN environment variable. See [API Documentation](https://v2.developer.pagerduty.com/docs/authentication) for more information.
* `token` - (Required) The v2 authorization token. It can also be sourced from the PAGERDUTY_TOKEN environment variable. See [API Documentation](https://developer.pagerduty.com/docs/rest-api-v2/authentication/) for more information.
* `skip_credentials_validation` - (Optional) Skip validation of the token against the PagerDuty API.
2 changes: 1 addition & 1 deletion website/docs/r/business_service.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty\_business\_service

A [business service](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Business_Services/get_business_services) allows you to model capabilities that span multiple technical services and that may be owned by several different teams.
A [business service](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1business_services/get) allows you to model capabilities that span multiple technical services and that may be owned by several different teams.


## Example Usage
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/escalation_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty\_escalation_policy

An [escalation policy](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Escalation_Policies/get_escalation_policies) determines what user or schedule will be notified first, second, and so on when an incident is triggered. Escalation policies are used by one or more services.
An [escalation policy](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1escalation_policies/get) determines what user or schedule will be notified first, second, and so on when an incident is triggered. Escalation policies are used by one or more services.


## Example Usage
Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/event_rule.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: |-
*NOTE: The `pagerduty_event_rule` resource has been deprecated in favor of the [pagerduty_ruleset](ruleset.html) and [pagerduty_ruleset_rule](ruleset_rule.html) resources. Please use the `ruleset` based resources for working with Event Rules.*


An [event rule](https://v2.developer.pagerduty.com/docs/global-event-rules-api) determines what happens to an event that is sent to PagerDuty by monitoring tools and other integrations.
An [event rule](https://developer.pagerduty.com/docs/rest-api-v2/global-event-rules-api/) determines what happens to an event that is sent to PagerDuty by monitoring tools and other integrations.


## Example Usage
Expand Down Expand Up @@ -91,7 +91,7 @@ The following arguments are supported:

* `action_json` - (Required) A list of one or more actions for each rule. Each action within the list is itself a list.
* `condition_json` - (Required) Contains a list of conditions. The first field in the list is `and` or `or`, followed by a list of operators and values.
* `advanced_condition_json` - (Optional) Contains a list of specific conditions including `active-between`,`scheduled-weekly`, and `frequency-over`. The first element in the list is the label for the condition, followed by a list of values for the specific condition. For more details on these conditions see [Advanced Condition](https://v2.developer.pagerduty.com/docs/global-event-rules-api#section-advanced-condition) in the PagerDuty API documentation.
* `advanced_condition_json` - (Optional) Contains a list of specific conditions including `active-between`,`scheduled-weekly`, and `frequency-over`. The first element in the list is the label for the condition, followed by a list of values for the specific condition. For more details on these conditions see [Advanced Condition](https://developer.pagerduty.com/docs/rest-api-v2/global-event-rules-api/#advanced-condition-parameter) in the PagerDuty API documentation.
* `depends_on` - (Optional) A [Terraform meta-parameter](https://www.terraform.io/docs/configuration-0-11/resources.html#depends_on) that ensures that the `event_rule` specified is created before the current rule. This is important because Event Rules in PagerDuty are executed in order. `depends_on` ensures that the rules are created in the order specified.

## Attributes Reference
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/extension.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty\_extension

An [extension](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Extensions/post_extensions) can be associated with a service.
An [extension](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1extensions/post) can be associated with a service.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/extension_servicenow.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty\_extension\_servicenow

A special case for [extension](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Extensions/post_extensions) for ServiceNow.
A special case for [extension](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1extensions/post) for ServiceNow.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/maintenance_window.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty_maintenance_window

A [maintenance window](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Maintenance_Windows/get_maintenance_windows) is used to temporarily disable one or more services for a set period of time. No incidents will be triggered and no notifications will be received while a service is disabled by a maintenance window.
A [maintenance window](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1maintenance_windows/get) is used to temporarily disable one or more services for a set period of time. No incidents will be triggered and no notifications will be received while a service is disabled by a maintenance window.

Maintenance windows are specified to start at a certain time and end after they have begun. Once started, a maintenance window cannot be deleted; it can only be ended immediately to re-enable the service.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/response_play.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty_response_play

A [response play](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Services/get_services) allows you to create packages of Incident Actions that can be applied during an Incident's life cycle.
A [response play](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1response_plays/get) allows you to create packages of Incident Actions that can be applied during an Incident's life cycle.


## Example Usage
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/schedule.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty\_schedule

A [schedule](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Schedules/get_schedules) determines the time periods that users are on call. Only on-call users are eligible to receive notifications from incidents.
A [schedule](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1schedules~1%7Bid%7D~1users/get) determines the time periods that users are on call. Only on-call users are eligible to receive notifications from incidents.


## Example Usage
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/service.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty\_service

A [service](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Services/get_services) represents something you monitor (like a web service, email service, or database service). It is a container for related incidents that associates them with escalation policies.
A [service](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1services/get) represents something you monitor (like a web service, email service, or database service). It is a container for related incidents that associates them with escalation policies.


## Example Usage
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/service_integration.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty\_service_integration

A [service integration](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Services/post_services_id_integrations) is an integration that belongs to a service.
A [service integration](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1services~1%7Bid%7D~1integrations/post) is an integration that belongs to a service.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/team.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty\_team

A [team](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Teams/get_teams) is a collection of users and escalation policies that represent a group of people within an organization.
A [team](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1teams/get) is a collection of users and escalation policies that represent a group of people within an organization.

The account must have the `teams` ability to use the following resource.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/team_membership.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty_team_membership

A [team membership](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Teams/put_teams_id_users_user_id) manages memberships within a team.
A [team membership](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1teams~1%7Bid%7D~1users~1%7Buser_id%7D/put) manages memberships within a team.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/user.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty\_user

A [user](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Users/get_users) is a member of a PagerDuty account that have the ability to interact with incidents and other data on the account.
A [user](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1users/get) is a member of a PagerDuty account that have the ability to interact with incidents and other data on the account.


## Example Usage
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/user_contact_method.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty_user_contact_method

A [contact method](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Users/get_users_id_contact_methods) is a contact method for a PagerDuty user (email, phone or SMS).
A [contact method](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1users~1%7Bid%7D~1contact_methods/get) is a contact method for a PagerDuty user (email, phone or SMS).


## Example Usage
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/user_notification_rule.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# pagerduty_user_notification_rule

A [notification rule](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Users/get_users_id_notification_rules_notification_rule_id) configures where and when a PagerDuty user is notified when a triggered incident is assigned to him. Unique notification rules can be created for both high and low-urgency incidents.
A [notification rule](https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1users~1%7Bid%7D~1notification_rules~1%7Bnotification_rule_id%7D/get) configures where and when a PagerDuty user is notified when a triggered incident is assigned to them. Unique notification rules can be created for both high and low-urgency incidents.

## Example Usage

Expand Down

0 comments on commit 298fc33

Please sign in to comment.