[Slo Correction] Add docs for recurring slo correction #1256
Conversation
| resource "datadog_slo_correction" "example_slo_correction_with_recurrence" { | ||
| category = "Scheduled Maintenance" | ||
| description = "correction example with recurrence" | ||
| start = 1735707000 |
There was a problem hiding this comment.
Nit - I wonder if there is a way to add a one line comment with human readable form
e.g start = 1735707000 # Tue Dec 31 23:50:00 EST 2024
There was a problem hiding this comment.
I think this is automatically generated so I'm not sure ..
There was a problem hiding this comment.
iirc, it is generated from the tf file under examples/, you can modify there.
| resource "datadog_slo_correction" "example_slo_correction_with_recurrence" { | ||
| category = "Scheduled Maintenance" | ||
| description = "correction example with recurrence" | ||
| start = 1735707000 |
| @@ -36,7 +36,7 @@ func resourceDatadogSloCorrection() *schema.Resource { | |||
| "end": { | |||
| Type: schema.TypeInt, | |||
| Required: true, | |||
There was a problem hiding this comment.
Required: true should be removed for rrule. may need to add a validation for one time correction if end is not given.
| "rrule": { | ||
| Type: schema.TypeString, | ||
| Optional: true, | ||
| Description: "Recurrence rules as defined in the iCalendar RFC 5545.", |
There was a problem hiding this comment.
maybe add a line for somefields that're not supported? something like dtstart, dtend, duration etc?
There was a problem hiding this comment.
ah we don't explicitly throw errors if things like dtstart and dtend are actually included in the rrule string - I think we can add a follow up for that then include in this doc
|
The provider doesn't seem to be updated for recurring correction. shouldn't we update the resource first before we publish the doc? |
| Required: true, | ||
| Description: "Ending time of the correction in epoch seconds.", | ||
| Optional: true, | ||
| Description: "Ending time of the correction in epoch seconds. Required for one time corrections, but optional if `rrule` is specified", |
There was a problem hiding this comment.
Can we mark this field to conflict with rrule and duration?
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Add documentation for recurring slo correction fields.