Skip to content

Commit

Permalink
Merge pull request #60 from incident-io/rorymalcolm/oncx-98-add-annot…
Browse files Browse the repository at this point in the history
…ations-to-public-api

Add annotations array to schedule terraform requests
  • Loading branch information
rorymalcolm committed May 8, 2024
2 parents fc7f516 + 2757cc9 commit c4d9d1c
Show file tree
Hide file tree
Showing 16 changed files with 505 additions and 246 deletions.
83 changes: 83 additions & 0 deletions docs/resources/schedule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "incident_schedule Resource - terraform-provider-incident"
subcategory: ""
description: |-
Beta:
View and manage schedules.
Manage your full schedule of on-call rotations, including the users and rotation configuration.
---

# incident_schedule (Resource)

Beta:
View and manage schedules.
Manage your full schedule of on-call rotations, including the users and rotation configuration.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String) Human readable name synced from external provider
- `rotations` (Attributes List) (see [below for nested schema](#nestedatt--rotations))
- `timezone` (String)

### Read-Only

- `id` (String) Unique internal ID of the schedule

<a id="nestedatt--rotations"></a>
### Nested Schema for `rotations`

Required:

- `id` (String) Unique internal ID of the rotation
- `name` (String) Human readable name synced from external provider
- `versions` (Attributes List) (see [below for nested schema](#nestedatt--rotations--versions))

<a id="nestedatt--rotations--versions"></a>
### Nested Schema for `rotations.versions`

Required:

- `handover_start_at` (String) Defines the next moment we'll trigger a handover
- `layers` (Attributes List) Controls how many people are on-call concurrently (see [below for nested schema](#nestedatt--rotations--versions--layers))
- `users` (List of String) The incident.io ID of a user

Optional:

- `effective_from` (String) When this rotation config will be effective from
- `handovers` (Attributes List) Defines the handover intervals for this rota, in order they should apply (see [below for nested schema](#nestedatt--rotations--versions--handovers))
- `working_intervals` (Attributes List) (see [below for nested schema](#nestedatt--rotations--versions--working_intervals))

<a id="nestedatt--rotations--versions--layers"></a>
### Nested Schema for `rotations.versions.layers`

Required:

- `id` (String)
- `name` (String)


<a id="nestedatt--rotations--versions--handovers"></a>
### Nested Schema for `rotations.versions.handovers`

Required:

- `interval` (Number)
- `interval_type` (String)


<a id="nestedatt--rotations--versions--working_intervals"></a>
### Nested Schema for `rotations.versions.working_intervals`

Required:

- `day` (String)
- `end` (String)
- `start` (String)


Loading

0 comments on commit c4d9d1c

Please sign in to comment.