From 5ff9fa20fdf250a7eb24b9ebe53fa6c4b1572c2d Mon Sep 17 00:00:00 2001 From: ymao1 Date: Tue, 17 Aug 2021 08:12:50 -0400 Subject: [PATCH] [Alerting][Docs] Add warning to create rule documentation about using `id` path parameter (#108552) (#108883) * Adding warning to docs * Trying different ref * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Being clearer about when rule ids get regenerated Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- docs/api/alerting/create_rule.asciidoc | 8 +++++--- docs/api/alerting/legacy/create.asciidoc | 8 +++++--- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/api/alerting/create_rule.asciidoc b/docs/api/alerting/create_rule.asciidoc index 01b6dfc40fcf6..24cde31d90873 100644 --- 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 -``:: - (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 index 8363569541356..44ea1496aac48 100644 --- 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 -``:: - (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