[Alerting][Docs] Add warning to create rule documentation about using…

… `id` path parameter (elastic#108552) (elastic#108883) * Adding warning to docs * Trying different ref * Apply suggestions from code review Co-authored-by: gchaps <[email protected]> * Being clearer about when rule ids get regenerated Co-authored-by: gchaps <[email protected]> Co-authored-by: gchaps <[email protected]>
kibanamachine · Aug 17, 2021 · 5ff9fa2 · 5ff9fa2
1 parent 2c4201b
commit 5ff9fa2
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/docs/api/alerting/create_rule.asciidoc b/docs/api/alerting/create_rule.asciidoc
@@ -16,12 +16,14 @@ Create {kib} rules.
 [[create-rule-api-path-params]]
 ==== Path parameters
 
-`<id>`::
-  (Optional, string) Specifies a UUID v1 or v4 to use instead of a randomly generated ID.
-
 `space_id`::
   (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
 
+WARNING: As part of the {kibana-ref-all}/master/sharing-saved-objects.html[Sharing Saved Objects] effort, IDs for rules in a custom space will be regenerated in 8.0.0. Rules created prior to 8.0.0 using this API that specify both the `id` and `space_id` path parameters will be re-assigned a randomly generated ID upon upgrading to 8.0.0.
+
+`id`::
+  (Optional, string) Specifies a UUID v1 or v4 to use instead of a randomly generated ID.
+
 [[create-rule-api-request-body]]
 ==== Request body
 

diff --git a/docs/api/alerting/legacy/create.asciidoc b/docs/api/alerting/legacy/create.asciidoc
@@ -18,12 +18,14 @@ Create {kib} alerts.
 [[alerts-api-create-path-params]]
 ==== Path parameters
 
-`<id>`::
-  (Optional, string) Specifies a UUID v1 or v4 to use instead of a randomly generated ID.
-
 `space_id`::
   (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
 
+WARNING: As part of the {kibana-ref-all}/master/sharing-saved-objects.html[Sharing Saved Objects] effort, IDs for rules in a custom space will be regenerated in 8.0.0. Rules created prior to 8.0.0 using this API that specify both the `id` and `space_id` path parameters will be re-assigned a randomly generated ID upon upgrading to 8.0.0.
+
+`id`::
+  (Optional, string) Specifies a UUID v1 or v4 to use instead of a randomly generated ID.
+
 [[alerts-api-create-request-body]]
 ==== Request body