Add support for the alert_delay param in the Create Rule API (#715)

* Initial commit. * Small change * Fix docs. * Add version check * Updated tests * more tests and version checks * Improve error message. Co-authored-by: Toby Brain <[email protected]> * Update version check Co-authored-by: Toby Brain <[email protected]> * PR comments * Changelog * Final changes --------- Co-authored-by: Toby Brain <[email protected]>
elastic · Aug 22, 2024 · ffa5f17 · ffa5f17
1 parent 0118d48
commit ffa5f17
Show file tree

Hide file tree

Showing 114 changed files with 11,413 additions and 3,061 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 ## [Unreleased]
 
+- Add the `alert_delay` field to the Create Rule API ([#715](https://github.com/elastic/terraform-provider-elasticstack/pull/715))
+
 ## [0.11.6] - 2024-08-20
+
 - Improve validation for index settings and mappings ([#719](https://github.com/elastic/terraform-provider-elasticstack/pull/719))
 - Add support for Kibana synthetics http and tcp monitors ([#699](https://github.com/elastic/terraform-provider-elasticstack/pull/699))
 - Add `elasticstack_kibana_spaces` data source ([#682](https://github.com/elastic/terraform-provider-elasticstack/pull/682))
@@ -16,6 +19,7 @@
 ## [0.11.4] - 2024-06-13
 
 ### Breaking changes
+
 - The `title` attribute is now required in the elasticstack_kibana_data_view resource. In practice the resource didn't work without this set, the schema now enforces it's correctly configured.
 
 ### Fixed
@@ -40,7 +44,7 @@
 
 ### Added
 
-- Added datasource for alerting connectors.  ([#607](https://github.com/elastic/terraform-provider-elasticstack/pull/607))
+- Added datasource for alerting connectors. ([#607](https://github.com/elastic/terraform-provider-elasticstack/pull/607))
 
 ## [0.11.2] - 2024-03-13
 
@@ -152,6 +156,7 @@
 - Add 'min\_\*' conditions to ILM rollover ([#250](https://github.com/elastic/terraform-provider-elasticstack/pull/250))
 - Add support for Kibana connections ([#226](https://github.com/elastic/terraform-provider-elasticstack/pull/226))
 - **[Breaking Change] Add 'deletion_protection' field to index resource** to avoid unintentional deletion. ([#167](https://github.com/elastic/terraform-provider-elasticstack/pull/167))
+
   - To delete index resource, you'll need to explicitly set `deletion_protection = false` as follows.
 
   ```terraform
@@ -186,6 +191,7 @@
 - Correctly handle empty logstash pipeline metadata in plan diffs ([#256](https://github.com/elastic/terraform-provider-elasticstack/pull/256))
 - Fix error when logging API requests in debug mode ([#259](https://github.com/elastic/terraform-provider-elasticstack/pull/259))
 - **[Breaking Change] Change `pipeline_metadata` type from schema.TypeMap to schema.TypeString**. This is to fix an error caused by updates to Logstash Pipelines outside of TF ([#278](https://github.com/elastic/terraform-provider-elasticstack/issues/278))
+
   - To use the updated `pipeline_metadata` field, you'll need to encapsulate any Terraform configuration with **jsonencode{}** as follows:
 
     ```terraform
@@ -211,6 +217,7 @@
       - run `terraform apply`
     - OR
       - reimport the resources into state using `terraform import` (<https://developer.hashicorp.com/terraform/cli/import>)
+
 - Fix order of `indices` field in SLM ([#326](https://github.com/elastic/terraform-provider-elasticstack/pull/326))
 
 ## [0.5.0] - 2022-12-07

diff --git a/Makefile b/Makefile
@@ -216,6 +216,7 @@ tools: $(GOBIN) ## Install useful tools for linting, docs generation and develop
 	@ cd tools && go install github.com/golangci/golangci-lint/cmd/golangci-lint
 	@ cd tools && go install github.com/goreleaser/goreleaser
 	@ cd tools && go install github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen
+	@ cd tools && go install go.uber.org/mock/mockgen
 
 .PHONY: misspell
 misspell:

diff --git a/docs/resources/kibana_alerting_rule.md b/docs/resources/kibana_alerting_rule.md
@@ -62,6 +62,7 @@ Could not create API key - Unsupported scheme "ApiKey" for granting API Key
 ### Optional
 
 - `actions` (Block List) An action that runs under defined conditions. (see [below for nested schema](#nestedblock--actions))
+- `alert_delay` (Number) A number that indicates how many consecutive runs need to meet the rule conditions for an alert to occur.
 - `enabled` (Boolean) Indicates if you want to run the rule on an interval basis.
 - `rule_id` (String) A UUID v1 or v4 to use instead of a randomly generated ID.
 - `space_id` (String) An identifier for the space. If space_id is not provided, the default space is used.

diff --git a/generated/alerting/.openapi-generator/FILES b/generated/alerting/.openapi-generator/FILES
@@ -6,36 +6,45 @@ api_alerting.go
 client.go
 configuration.go
 docs/ActionsInner.md
+docs/ActionsInnerAlertsFilter.md
+docs/ActionsInnerAlertsFilterQuery.md
+docs/ActionsInnerAlertsFilterTimeframe.md
+docs/ActionsInnerAlertsFilterTimeframeHours.md
 docs/ActionsInnerFrequency.md
+docs/AlertDelay.md
 docs/AlertResponseProperties.md
 docs/AlertResponsePropertiesExecutionStatus.md
 docs/AlertResponsePropertiesSchedule.md
 docs/AlertingAPI.md
 docs/CreateRuleRequest.md
+docs/FieldmapProperties.md
+docs/FieldmapPropertiesPropertiesValue.md
+docs/Filter.md
+docs/FilterMeta.md
 docs/FindRules200Response.md
 docs/FindRulesHasReferenceParameter.md
-docs/FindRulesSearchFieldsParameter.md
 docs/GetAlertingHealth200Response.md
 docs/GetAlertingHealth200ResponseAlertingFrameworkHealth.md
 docs/GetAlertingHealth200ResponseAlertingFrameworkHealthDecryptionHealth.md
 docs/GetAlertingHealth200ResponseAlertingFrameworkHealthExecutionHealth.md
 docs/GetAlertingHealth200ResponseAlertingFrameworkHealthReadHealth.md
-docs/GetAlertingHealth200ResponseAlertingFrameworkHeath.md
-docs/GetAlertingHealth200ResponseAlertingFrameworkHeathDecryptionHealth.md
 docs/GetRuleTypes200ResponseInner.md
 docs/GetRuleTypes200ResponseInnerActionGroupsInner.md
 docs/GetRuleTypes200ResponseInnerActionVariables.md
 docs/GetRuleTypes200ResponseInnerActionVariablesContextInner.md
 docs/GetRuleTypes200ResponseInnerActionVariablesParamsInner.md
+docs/GetRuleTypes200ResponseInnerActionVariablesStateInner.md
+docs/GetRuleTypes200ResponseInnerAlerts.md
+docs/GetRuleTypes200ResponseInnerAlertsMappings.md
 docs/GetRuleTypes200ResponseInnerAuthorizedConsumers.md
 docs/GetRuleTypes200ResponseInnerAuthorizedConsumersAlerts.md
 docs/GetRuleTypes200ResponseInnerRecoveryActionGroup.md
 docs/LegacyCreateAlertRequestProperties.md
-docs/LegacyCreateAlertRequestPropertiesSchedule.md
 docs/LegacyFindAlerts200Response.md
+docs/LegacyFindAlertsHasReferenceParameter.md
 docs/LegacyGetAlertTypes200ResponseInner.md
+docs/LegacyGetAlertTypes200ResponseInnerActionGroupsInner.md
 docs/LegacyGetAlertTypes200ResponseInnerActionVariables.md
-docs/LegacyGetAlertTypes200ResponseInnerActionVariablesContextInner.md
 docs/LegacyGetAlertTypes200ResponseInnerRecoveryActionGroup.md
 docs/LegacyGetAlertingHealth200Response.md
 docs/LegacyGetAlertingHealth200ResponseAlertingFrameworkHealth.md
@@ -45,6 +54,7 @@ docs/LegacyGetAlertingHealth200ResponseAlertingFrameworkHealthReadHealth.md
 docs/LegacyUpdateAlertRequestProperties.md
 docs/LegacyUpdateAlertRequestPropertiesActionsInner.md
 docs/LegacyUpdateAlertRequestPropertiesSchedule.md
+docs/Model400Response.md
 docs/Model401Response.md
 docs/Model404Response.md
 docs/NotifyWhen.md
@@ -57,38 +67,48 @@ docs/UpdateRuleRequest.md
 git_push.sh
 go.mod
 go.sum
+model_400_response.go
 model_401_response.go
 model_404_response.go
 model_actions_inner.go
+model_actions_inner_alerts_filter.go
+model_actions_inner_alerts_filter_query.go
+model_actions_inner_alerts_filter_timeframe.go
+model_actions_inner_alerts_filter_timeframe_hours.go
 model_actions_inner_frequency.go
+model_alert_delay.go
 model_alert_response_properties.go
 model_alert_response_properties_execution_status.go
 model_alert_response_properties_schedule.go
 model_create_rule_request.go
+model_fieldmap_properties.go
+model_fieldmap_properties_properties_value.go
+model_filter.go
+model_filter_meta.go
 model_find_rules_200_response.go
 model_find_rules_has_reference_parameter.go
-model_find_rules_search_fields_parameter.go
 model_get_alerting_health_200_response.go
 model_get_alerting_health_200_response_alerting_framework_health.go
 model_get_alerting_health_200_response_alerting_framework_health_decryption_health.go
 model_get_alerting_health_200_response_alerting_framework_health_execution_health.go
 model_get_alerting_health_200_response_alerting_framework_health_read_health.go
-model_get_alerting_health_200_response_alerting_framework_heath.go
-model_get_alerting_health_200_response_alerting_framework_heath_decryption_health.go
 model_get_rule_types_200_response_inner.go
 model_get_rule_types_200_response_inner_action_groups_inner.go
 model_get_rule_types_200_response_inner_action_variables.go
 model_get_rule_types_200_response_inner_action_variables_context_inner.go
 model_get_rule_types_200_response_inner_action_variables_params_inner.go
+model_get_rule_types_200_response_inner_action_variables_state_inner.go
+model_get_rule_types_200_response_inner_alerts.go
+model_get_rule_types_200_response_inner_alerts_mappings.go
 model_get_rule_types_200_response_inner_authorized_consumers.go
 model_get_rule_types_200_response_inner_authorized_consumers_alerts.go
 model_get_rule_types_200_response_inner_recovery_action_group.go
 model_legacy_create_alert_request_properties.go
-model_legacy_create_alert_request_properties_schedule.go
 model_legacy_find_alerts_200_response.go
+model_legacy_find_alerts_has_reference_parameter.go
 model_legacy_get_alert_types_200_response_inner.go
+model_legacy_get_alert_types_200_response_inner_action_groups_inner.go
 model_legacy_get_alert_types_200_response_inner_action_variables.go
-model_legacy_get_alert_types_200_response_inner_action_variables_context_inner.go
 model_legacy_get_alert_types_200_response_inner_recovery_action_group.go
 model_legacy_get_alerting_health_200_response.go
 model_legacy_get_alerting_health_200_response_alerting_framework_health.go
@@ -99,6 +119,7 @@ model_legacy_update_alert_request_properties.go
 model_legacy_update_alert_request_properties_actions_inner.go
 model_legacy_update_alert_request_properties_schedule.go
 model_notify_when.go
+model_notify_when_action.go
 model_rule_response_properties.go
 model_rule_response_properties_execution_status.go
 model_rule_response_properties_last_run.go