Skip to content

Commit 5666c73

Browse files
author
a_nackov
authored
chore(serverupdate, serverbackup): update field descriptions (#1221)
relates to STACKITSBM-463
1 parent c8c93f1 commit 5666c73

File tree

12 files changed

+18
-18
lines changed

12 files changed

+18
-18
lines changed

docs/data-sources/server_backup_schedule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ data "stackit_server_backup_schedule" "example" {
4242
- `enabled` (Boolean) Is the backup schedule enabled or disabled.
4343
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`server_id`,`backup_schedule_id`".
4444
- `name` (String) The schedule name.
45-
- `rrule` (String) Backup schedule described in `rrule` (recurrence rule) format.
45+
- `rrule` (String) An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
4646

4747
<a id="nestedatt--backup_properties"></a>
4848
### Nested Schema for `backup_properties`

docs/data-sources/server_backup_schedules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Read-Only:
4848
- `backup_schedule_id` (Number)
4949
- `enabled` (Boolean) Is the backup schedule enabled or disabled.
5050
- `name` (String) The backup schedule name.
51-
- `rrule` (String) Backup schedule described in `rrule` (recurrence rule) format.
51+
- `rrule` (String) An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
5252

5353
<a id="nestedatt--items--backup_properties"></a>
5454
### Nested Schema for `items.backup_properties`

docs/data-sources/server_update_schedule.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,6 @@ data "stackit_server_update_schedule" "example" {
4040

4141
- `enabled` (Boolean) Is the update schedule enabled or disabled.
4242
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`region`,`server_id`,`update_schedule_id`".
43-
- `maintenance_window` (Number) Maintenance window [1..24].
43+
- `maintenance_window` (Number) Maintenance window [1..24]. Updates start within the defined hourly window. Depending on the updates, the process may exceed this timeframe and require an automatic restart.
4444
- `name` (String) The schedule name.
45-
- `rrule` (String) Update schedule described in `rrule` (recurrence rule) format.
45+
- `rrule` (String) An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.

docs/data-sources/server_update_schedules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ data "stackit_server_update_schedules" "example" {
4545
Read-Only:
4646

4747
- `enabled` (Boolean) Is the update schedule enabled or disabled.
48-
- `maintenance_window` (Number) Maintenance window [1..24].
48+
- `maintenance_window` (Number) Maintenance window [1..24]. Updates start within the defined hourly window. Depending on the updates, the process may exceed this timeframe and require an automatic restart.
4949
- `name` (String) The update schedule name.
50-
- `rrule` (String) Update schedule described in `rrule` (recurrence rule) format.
50+
- `rrule` (String) An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
5151
- `update_schedule_id` (Number)

docs/resources/server_backup_schedule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ import {
4545
- `enabled` (Boolean) Is the backup schedule enabled or disabled.
4646
- `name` (String) The schedule name.
4747
- `project_id` (String) STACKIT Project ID to which the server is associated.
48-
- `rrule` (String) Backup schedule described in `rrule` (recurrence rule) format.
48+
- `rrule` (String) An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
4949
- `server_id` (String) Server ID for the backup schedule.
5050

5151
### Optional

docs/resources/server_update_schedule.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ import {
3838
### Required
3939

4040
- `enabled` (Boolean) Is the update schedule enabled or disabled.
41-
- `maintenance_window` (Number) Maintenance window [1..24].
41+
- `maintenance_window` (Number) Maintenance window [1..24]. Updates start within the defined hourly window. Depending on the updates, the process may exceed this timeframe and require an automatic restart.
4242
- `name` (String) The schedule name.
4343
- `project_id` (String) STACKIT Project ID to which the server is associated.
44-
- `rrule` (String) Update schedule described in `rrule` (recurrence rule) format.
44+
- `rrule` (String) An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
4545
- `server_id` (String) Server ID for the update schedule.
4646

4747
### Optional

stackit/internal/services/serverbackup/schedule/resource.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ func (r *scheduleResource) Schema(_ context.Context, _ resource.SchemaRequest, r
186186
},
187187
},
188188
"rrule": schema.StringAttribute{
189-
Description: "Backup schedule described in `rrule` (recurrence rule) format.",
189+
Description: "An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.",
190190
Required: true,
191191
PlanModifiers: []planmodifier.String{
192192
stringplanmodifier.RequiresReplace(),

stackit/internal/services/serverbackup/schedule/schedule_datasource.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ func (r *scheduleDataSource) Schema(_ context.Context, _ datasource.SchemaReques
108108
},
109109
},
110110
"rrule": schema.StringAttribute{
111-
Description: "Backup schedule described in `rrule` (recurrence rule) format.",
111+
Description: "An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.",
112112
Computed: true,
113113
},
114114
"enabled": schema.BoolAttribute{

stackit/internal/services/serverbackup/schedule/schedules_datasource.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ func (r *schedulesDataSource) Schema(_ context.Context, _ datasource.SchemaReque
110110
Computed: true,
111111
},
112112
"rrule": schema.StringAttribute{
113-
Description: "Backup schedule described in `rrule` (recurrence rule) format.",
113+
Description: "An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.",
114114
Computed: true,
115115
},
116116
"enabled": schema.BoolAttribute{

stackit/internal/services/serverupdate/schedule/resource.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ func (r *scheduleResource) Schema(_ context.Context, _ resource.SchemaRequest, r
177177
},
178178
},
179179
"rrule": schema.StringAttribute{
180-
Description: "Update schedule described in `rrule` (recurrence rule) format.",
180+
Description: "An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.",
181181
Required: true,
182182
PlanModifiers: []planmodifier.String{
183183
stringplanmodifier.RequiresReplace(),
@@ -193,7 +193,7 @@ func (r *scheduleResource) Schema(_ context.Context, _ resource.SchemaRequest, r
193193
Required: true,
194194
},
195195
"maintenance_window": schema.Int64Attribute{
196-
Description: "Maintenance window [1..24].",
196+
Description: "Maintenance window [1..24]. Updates start within the defined hourly window. Depending on the updates, the process may exceed this timeframe and require an automatic restart.",
197197
Required: true,
198198
Validators: []validator.Int64{
199199
int64validator.AtLeast(1),

0 commit comments

Comments
 (0)