Skip to content

Commit

Permalink
Update docs (#70)
Browse files Browse the repository at this point in the history
  • Loading branch information
JanPokorny committed Feb 13, 2024
1 parent aa9a772 commit 28f420a
Show file tree
Hide file tree
Showing 20 changed files with 136 additions and 116 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ GOLANGCI_LINT := golangci-lint run --disable-all \
-E staticcheck \
-E typecheck \
-E unused
VERSION := 0.6.0
VERSION := 0.6.1
.PHONY: test build

help:
Expand Down
4 changes: 4 additions & 0 deletions docs/data-sources/betteruptime_monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,11 @@ Monitor lookup.

`imap` We will check for an IMAP server at the host specified in the url parameter
(port is required, and can be 143, 993, or both).

`playwright` We will run the scenario defined by playwright_script, identified in the UI by scenario_name
- **paused** (Boolean) Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring.
- **paused_at** (String) The time when this monitor was paused.
- **playwright_script** (String) For Playwright monitors, the JavaScript source code of the scenario.
- **policy_id** (String) Set the escalation policy for the monitor.
- **port** (String) Required if monitor_type is set to tcp, udp, smtp, pop, or imap. tcp and udp monitors accept any ports, while smtp, pop, and imap accept only the specified ports corresponding with their servers (e.g. "25,465,587" for smtp).
- **pronounceable_name** (String) Pronounceable name of the monitor. We will use this when we call you. Try to make it tongue-friendly, please?
Expand All @@ -77,6 +80,7 @@ Monitor lookup.
- **request_headers** (List of Map of String) An array of request headers, consisting of name and value pairs
- **request_timeout** (Number) How long to wait before timing out the request? In seconds.
- **required_keyword** (String) Required if monitor_type is set to keyword or udp. We will create a new incident if this keyword is missing on your page.
- **scenario_name** (String) For Playwright monitors, the scenario name identifying the monitor in the UI.
- **sms** (Boolean) Should we send an SMS to the on-call person?
- **ssl_expiration** (Number) How many days before the SSL certificate expires do you want to be alerted? Valid values are 1, 2, 3, 7, 14, 30, and 60.
- **status** (String) The status of this website check.
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/betteruptime_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Read-Only:
Read-Only:

- **id** (Number)
- **team_id** (Number)
- **type** (String)


20 changes: 10 additions & 10 deletions docs/resources/betteruptime_aws_cloudwatch_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ https://betterstack.com/docs/uptime/api/aws-cloudwatch-integrations/

### Optional

- **call** (Boolean) Should we call the on-call person?
- **email** (Boolean) Should we send an email to the on-call person?
- **name** (String) The name of this AWS CloudWatch integration.
- **paused** (Boolean) Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring.
- **call** (Boolean) Do we call the on-call person?
- **email** (Boolean) Do we send an email to the on-call person?
- **id** (String) The ID of the AWS CloudWatch Integration.
- **name** (String) The name of the AWS CloudWatch Integration.
- **paused** (Boolean) Is the AWS CloudWatch integration paused.
- **policy_id** (Number) ID of the escalation policy associated with the AWS CloudWatch integration.
- **push** (Boolean) Should we send a push notification to the on-call person?
- **recovery_period** (Number) How long the integration must be up to automatically mark an incident as resolved after being down.
- **sms** (Boolean) Should we send an SMS to the on-call person?
- **team_wait** (Number) How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team.
- **push** (Boolean) Do we send a push notification to the on-call person?
- **recovery_period** (Number) How long the alert must be up to automatically mark an incident as resolved. In seconds.
- **sms** (Boolean) Do we send an SMS to the on-call person?
- **team_wait** (Number) How long we wait before escalating the incident alert to the team. In seconds.

### Read-Only

- **id** (String) The ID of this AWS CloudWatch integration.
- **webhook_url** (String) The URL to which to point the AWS CloudWatch webhook to.
- **webhook_url** (String) The webhook URL for the AWS CloudWatch integration.


22 changes: 12 additions & 10 deletions docs/resources/betteruptime_azure_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,19 @@ https://betterstack.com/docs/uptime/api/azure-integrations/

### Optional

- **call** (Boolean) Should we call the on-call person?
- **email** (Boolean) Should we send an email to the on-call person?
- **name** (String) The name of this Azure integration.
- **paused** (Boolean) Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring.
- **call** (Boolean) Do we call the on-call person?
- **email** (Boolean) Do we send an email to the on-call person?
- **id** (String) The ID of the Azure Integration.
- **name** (String) The name of the Azure Integration.
- **paused** (Boolean) Is the Azure integration paused.
- **policy_id** (Number) ID of the escalation policy associated with the Azure integration.
- **push** (Boolean) Should we send a push notification to the on-call person?
- **recovery_period** (Number) How long the integration must be up to automatically mark an incident as resolved after being down.
- **sms** (Boolean) Should we send an SMS to the on-call person?
- **team_wait** (Number) How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team.
- **push** (Boolean) Do we send a push notification to the on-call person?
- **recovery_period** (Number) How long the alert must be up to automatically mark an incident as resolved. In seconds.
- **sms** (Boolean) Do we send an SMS to the on-call person?
- **team_wait** (Number) How long we wait before escalating the incident alert to the team. In seconds.

### Read-Only

- **id** (String) The ID of this Azure integration.
- **webhook_url** (String) The URL to which to point the Azure webhook to.
- **webhook_url** (String) The webhook URL for the Azure integration.


22 changes: 11 additions & 11 deletions docs/resources/betteruptime_datadog_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@ https://betterstack.com/docs/uptime/api/datadog-integrations/

### Optional

- **call** (Boolean) Should we call the on-call person?
- **email** (Boolean) Should we send an email to the on-call person?
- **name** (String) The name of this Datadog integration.
- **paused** (Boolean) Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring.
- **alerting_rule** (String) Should we alert only on alarms, or on both alarms and warnings. Possible values: alert, alert_and_warn.
- **call** (Boolean) Do we call the on-call person?
- **email** (Boolean) Do we send an email to the on-call person?
- **id** (String) The ID of the Datadog Integration.
- **name** (String) The name of the Datadog Integration.
- **paused** (Boolean) Is the Datadog integration paused.
- **policy_id** (Number) ID of the escalation policy associated with the Datadog integration.
- **push** (Boolean) Should we send a push notification to the on-call person?
- **recovery_period** (Number) How long the integration must be up to automatically mark an incident as resolved after being down.
- **sms** (Boolean) Should we send an SMS to the on-call person?
- **team_wait** (Number) How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team.
- **alerting_rule** (String) Should we alert only on alarms, or on both alarms and warnings. Possible values: `alert`, `alert_and_warn`.
- **push** (Boolean) Do we send a push notification to the on-call person?
- **recovery_period** (Number) How long the alert must be up to automatically mark an incident as resolved. In seconds.
- **sms** (Boolean) Do we send an SMS to the on-call person?
- **team_wait** (Number) How long we wait before escalating the incident alert to the team. In seconds.

### Read-Only

- **id** (String) The ID of this Datadog integration.
- **webhook_url** (String) The URL to which to point the Datadog webhook to.
- **webhook_url** (String) The webhook URL for the Datadog integration.


2 changes: 1 addition & 1 deletion docs/resources/betteruptime_email_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ https://betterstack.com/docs/uptime/api/email-integrations/
- **other_resolved_fields** (Block List) An array of additional fields, which will be extracted when resolving an incident. (see [below for nested schema](#nestedblock--other_resolved_fields))
- **other_started_fields** (Block List) An array of additional fields, which will be extracted when starting an incident. (see [below for nested schema](#nestedblock--other_started_fields))
- **paused** (Boolean) Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring.
- **policy_id** (Number) ID of the escalation policy associated with the email integration.
- **policy_id** (String) ID of the escalation policy associated with the email integration.
- **push** (Boolean) Should we send a push notification to the on-call person?
- **recovery_period** (Number) How long the integration must be up to automatically mark an incident as resolved after being down.
- **resolved_alert_id_field** (Block Set) When resolving an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents. (see [below for nested schema](#nestedblock--resolved_alert_id_field))
Expand Down
20 changes: 10 additions & 10 deletions docs/resources/betteruptime_google_monitoring_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ https://betterstack.com/docs/uptime/api/google-monitoring-integrations/

### Optional

- **call** (Boolean) Should we call the on-call person?
- **email** (Boolean) Should we send an email to the on-call person?
- **name** (String) The name of this Google Monitoring integration.
- **paused** (Boolean) Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring.
- **call** (Boolean) Do we call the on-call person?
- **email** (Boolean) Do we send an email to the on-call person?
- **id** (String) The ID of the Google Monitoring Integration.
- **name** (String) The name of the Google Monitoring Integration.
- **paused** (Boolean) Is the Google Monitoring integration paused.
- **policy_id** (Number) ID of the escalation policy associated with the Google Monitoring integration.
- **push** (Boolean) Should we send a push notification to the on-call person?
- **recovery_period** (Number) How long the integration must be up to automatically mark an incident as resolved after being down.
- **sms** (Boolean) Should we send an SMS to the on-call person?
- **team_wait** (Number) How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team.
- **push** (Boolean) Do we send a push notification to the on-call person?
- **recovery_period** (Number) How long the alert must be up to automatically mark an incident as resolved. In seconds.
- **sms** (Boolean) Do we send an SMS to the on-call person?
- **team_wait** (Number) How long we wait before escalating the incident alert to the team. In seconds.

### Read-Only

- **id** (String) The ID of this Google Monitoring integration.
- **webhook_url** (String) The URL to which to point the Google Monitoring webhook to.
- **webhook_url** (String) The webhook URL for the Google Monitoring integration.


20 changes: 10 additions & 10 deletions docs/resources/betteruptime_grafana_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ https://betterstack.com/docs/uptime/api/grafana-integrations/

### Optional

- **call** (Boolean) Should we call the on-call person?
- **email** (Boolean) Should we send an email to the on-call person?
- **name** (String) The name of this Grafana integration.
- **paused** (Boolean) Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring.
- **call** (Boolean) Do we call the on-call person?
- **email** (Boolean) Do we send an email to the on-call person?
- **id** (String) The ID of the Grafana Integration.
- **name** (String) The name of the Grafana Integration.
- **paused** (Boolean) Is the Grafana integration paused.
- **policy_id** (Number) ID of the escalation policy associated with the Grafana integration.
- **push** (Boolean) Should we send a push notification to the on-call person?
- **recovery_period** (Number) How long the integration must be up to automatically mark an incident as resolved after being down.
- **sms** (Boolean) Should we send an SMS to the on-call person?
- **team_wait** (Number) How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team.
- **push** (Boolean) Do we send a push notification to the on-call person?
- **recovery_period** (Number) How long the alert must be up to automatically mark an incident as resolved. In seconds.
- **sms** (Boolean) Do we send an SMS to the on-call person?
- **team_wait** (Number) How long we wait before escalating the incident alert to the team. In seconds.

### Read-Only

- **id** (String) The ID of this Grafana integration.
- **webhook_url** (String) The URL to which to point the Grafana webhook to.
- **webhook_url** (String) The webhook URL for the Grafana integration.


14 changes: 7 additions & 7 deletions docs/resources/betteruptime_metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ https://betterstack.com/docs/uptime/api/metadata/

### Required

- **Owner type** (String) Valid values: `Monitor`, `Heartbeat`, `Incident`, `WebhookIntegration`, `EmailIntegration`, `IncomingWebhook`
- **Owner ID** (String) The ID of the resource owning this metadata.
- **Key** (String) The key of this metadata.
- **Value** (String) The value of this metadata.
- **key** (String) The key of this Metadata.
- **owner_id** (Number) The ID of the owner of this Metadata.
- **owner_type** (String) The type of the owner of this Metadata. Valid values: `Monitor`, `Heartbeat`, `Incident`, `WebhookIntegration`, `EmailIntegration`, `IncomingWebhook`
- **value** (String) The value of this Metadata.

### Read-Only

- **created_at** (String) The time when this monitor was created.
- **id** (String) The ID of this Monitor.
- **updated_at** (String) The time when this monitor was updated.
- **created_at** (String) The time when this metadata was created.
- **id** (String) The ID of this Metadata.
- **updated_at** (String) The time when this metadata was updated.


4 changes: 4 additions & 0 deletions docs/resources/betteruptime_monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ https://betterstack.com/docs/uptime/api/monitors/

`imap` We will check for an IMAP server at the host specified in the url parameter
(port is required, and can be 143, 993, or both).

`playwright` We will run the scenario defined by playwright_script, identified in the UI by scenario_name
- **url** (String) URL of your website or the host you want to ping (see monitor_type below).

### Optional
Expand All @@ -62,6 +64,7 @@ https://betterstack.com/docs/uptime/api/monitors/
- **maintenance_to** (String) End of the maintenance window each day. Example: "03:00:00"
- **monitor_group_id** (Number) Set this attribute if you want to add this monitor to a monitor group.
- **paused** (Boolean) Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring.
- **playwright_script** (String) For Playwright monitors, the JavaScript source code of the scenario.
- **policy_id** (String) Set the escalation policy for the monitor.
- **port** (String) Required if monitor_type is set to tcp, udp, smtp, pop, or imap. tcp and udp monitors accept any ports, while smtp, pop, and imap accept only the specified ports corresponding with their servers (e.g. "25,465,587" for smtp).
- **pronounceable_name** (String) Pronounceable name of the monitor. We will use this when we call you. Try to make it tongue-friendly, please?
Expand All @@ -73,6 +76,7 @@ https://betterstack.com/docs/uptime/api/monitors/
- **request_headers** (List of Map of String) An array of request headers, consisting of name and value pairs
- **request_timeout** (Number) How long to wait before timing out the request? In seconds.
- **required_keyword** (String) Required if monitor_type is set to keyword or udp. We will create a new incident if this keyword is missing on your page.
- **scenario_name** (String) For Playwright monitors, the scenario name identifying the monitor in the UI.
- **sms** (Boolean) Should we send an SMS to the on-call person?
- **ssl_expiration** (Number) How many days before the SSL certificate expires do you want to be alerted? Valid values are 1, 2, 3, 7, 14, 30, and 60.
- **team_wait** (Number) How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. In seconds.
Expand Down
24 changes: 12 additions & 12 deletions docs/resources/betteruptime_new_relic_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@ https://betterstack.com/docs/uptime/api/new-relic-integrations/

### Optional

- **call** (Boolean) Should we call the on-call person?
- **email** (Boolean) Should we send an email to the on-call person?
- **name** (String) The name of this New Relic integration.
- **paused** (Boolean) Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring.
- **policy_id** (Number) ID of the escalation policy associated with the New Relic integration.
- **push** (Boolean) Should we send a push notification to the on-call person?
- **recovery_period** (Number) How long the integration must be up to automatically mark an incident as resolved after being down.
- **sms** (Boolean) Should we send an SMS to the on-call person?
- **team_wait** (Number) How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team.
- **alerting_rule** (String) Should we alert only on alarms, or on both alarms and warnings. Possible values: `alert`, `alert_and_warn`.
- **alerting_rule** (String) Should we alert only on alarms, or on both alarms and warnings. Possible values: alert, alert_and_warn.
- **call** (Boolean) Do we call the on-call person?
- **email** (Boolean) Do we send an email to the on-call person?
- **id** (String) The ID of the AWS CloudWatch Integration.
- **name** (String) The name of the AWS CloudWatch Integration.
- **paused** (Boolean) Is the AWS CloudWatch integration paused.
- **policy_id** (Number) ID of the escalation policy associated with the AWS CloudWatch integration.
- **push** (Boolean) Do we send a push notification to the on-call person?
- **recovery_period** (Number) How long the alert must be up to automatically mark an incident as resolved. In seconds.
- **sms** (Boolean) Do we send an SMS to the on-call person?
- **team_wait** (Number) How long we wait before escalating the incident alert to the team. In seconds.

### Read-Only

- **id** (String) The ID of this New Relic integration.
- **webhook_url** (String) The URL to which to point the New Relic webhook to.
- **webhook_url** (String) The webhook URL for the AWS CloudWatch integration.


10 changes: 7 additions & 3 deletions docs/resources/betteruptime_pagerduty_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,16 @@ https://betterstack.com/docs/uptime/api/pagerduty-integrations/
<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **key** (String) The PagerDuty routing key.

### Optional
- **name** (String) The name of this PagerDuty integration.
- **key** (String) The routing key for this PagerDuty integration.

- **name** (String) The name of the PagerDuty Integration.

### Read-Only

- **id** (String) The ID of this PagerDuty integration.
- **id** (String) The ID of the PagerDuty Integration.


3 changes: 2 additions & 1 deletion docs/resources/betteruptime_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Required:

Optional:

- **id** (Number) The ID of the resource to notify during an incident. Required for user, webhook, slack_integration, microsoft_teams_integration and zapier_webhook member types. This is e.g. the ID of the user to notify when member type is user. Can be used for entire_team member type to specify the ID of the team to notify (current team if not provided).
- **id** (Number) The ID of the resource to notify during an incident. Required for user, webhook, slack_integration, microsoft_teams_integration and zapier_webhook member types. This is e.g. the ID of the user to notify when member type is user.
- **team_id** (Number, Deprecated) The ID of the team to notify when member team is entire_team. When left empty, the default team for the incident is used.


Loading

0 comments on commit 28f420a

Please sign in to comment.