From 68787b6aea6d0e7b4de6501e78602259d0c2d551 Mon Sep 17 00:00:00 2001 From: Joe Portner <5295965+jportner@users.noreply.github.com> Date: Thu, 26 Aug 2021 11:58:06 -0400 Subject: [PATCH 1/7] Add docs for legacy URL aliases --- .../disable_legacy_url_aliases.asciidoc | 48 +++++++++++++++++++ docs/developer/advanced/index.asciidoc | 5 +- .../advanced/legacy-url-aliases.asciidoc | 45 +++++++++++++++++ 3 files changed, 97 insertions(+), 1 deletion(-) create mode 100644 docs/api/spaces-management/disable_legacy_url_aliases.asciidoc create mode 100644 docs/developer/advanced/legacy-url-aliases.asciidoc diff --git a/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc b/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc new file mode 100644 index 0000000000000..9b54b9c1b7f6d --- /dev/null +++ b/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc @@ -0,0 +1,48 @@ +[[spaces-api-disable-legacy-url-aliases]] +=== Create space API +++++ +Disable legacy URL aliases +++++ + +experimental[] Disable a <> in {kib}. + +[[spaces-api-disable-legacy-url-aliases-request]] +==== Request + +`POST :/api/spaces/_disable_legacy_url_aliases` + +[[spaces-api-disable-legacy-url-aliases-request-body]] +==== Request body + +`targetSpace`:: + (Required, string) The space where the alias target object exists. + +`targetType`:: + (Required, string) The type of the alias target object. + +`sourceId`:: + (Required, string) The ID of the alias source object. This is the "legacy" object ID. + +[[spaces-api-disable-legacy-url-aliases-response-codes]] +==== Response codes + +`204`:: + Indicates a successful call. + +[[spaces-api-disable-legacy-url-aliases-example]] +==== Example + +[source,sh] +-------------------------------------------------- +$ curl -X POST api/spaces/_disable_legacy_url_aliases +{ + "targetSpace": "bills-space", + "targetType": "dashboard", + "sourceId": "123" +} +-------------------------------------------------- +// KIBANA + +This will leave the alias intact, but the legacy URL for this alias will no longer function. In this example, you had a legacy URL for +`http://localhost:5601/s/bills-space/app/dashboards#/view/123`. That URL would no longer work after making this API call, but the dashboard +itself still exists and can be accessed by its new URL. \ No newline at end of file diff --git a/docs/developer/advanced/index.asciidoc b/docs/developer/advanced/index.asciidoc index 289b88cddd7a9..27072d85b6507 100644 --- a/docs/developer/advanced/index.asciidoc +++ b/docs/developer/advanced/index.asciidoc @@ -6,6 +6,7 @@ * <> * <> * <> +* <> include::development-es-snapshots.asciidoc[leveloffset=+1] @@ -15,4 +16,6 @@ include::development-basepath.asciidoc[leveloffset=+1] include::upgrading-nodejs.asciidoc[leveloffset=+1] -include::sharing-saved-objects.asciidoc[leveloffset=+1] \ No newline at end of file +include::sharing-saved-objects.asciidoc[leveloffset=+1] + +include::legacy-url-aliases.asciidoc[leveloffset=+1] \ No newline at end of file diff --git a/docs/developer/advanced/legacy-url-aliases.asciidoc b/docs/developer/advanced/legacy-url-aliases.asciidoc new file mode 100644 index 0000000000000..92d9aa2c30259 --- /dev/null +++ b/docs/developer/advanced/legacy-url-aliases.asciidoc @@ -0,0 +1,45 @@ +[[legacy-url-aliases]] +== Legacy URL Aliases + +This page describes legacy URL aliases: what they are, where they come from, and how to disable them. + +[[legacy-url-aliases-overview]] +=== Overview + +Many saved object types are being converted in the 8.0 release of {kib} so they can eventually be shared across <>. +Before 8.0, you could have two objects with the same type and same ID in two different spaces. Part of this conversion is to make sure all +object IDs of a given type are *globally unique across all spaces*. + +When a saved object is converted, if its ID is changed, {kib} creates a special entity called a _legacy URL alias_. This allows us to +preserve any deep link URLs that may exist for that object. + +[[legacy-url-aliases-example]] +=== Example + +For example, consider the following scenario: + +You have {kib} 7.16 installed and you created a new dashboard. This dashboard's ID is "123". Then, you create a new space called "Bill's space", and copy your dashboard to the other space. Now you have two different dashboards that can be accessed at the following URLs: + +* *Default space*: `http://localhost:5601/app/dashboards#/view/123` +* *Bill's space*: `http://localhost:5601/s/bills-space/app/dashboards#/view/123` + +You use these two dashboards frequently, so you use your web browser to add bookmarks for them. After some time, you decide upgrade to {kib} +8.0. When these two dashboards go through the conversion process, the one in "Bill's space" will have its ID changed to "456". Now, the URL +to access that dashboard is different -- not to worry though, there is a legacy URL alias for that dashboard! + +If you use your bookmark to access that dashboard using its old URL, {kib} detects that you are using a legacy URL and it finds the new +object ID. This means if you navigate to `http://localhost:5601/s/bills-space/app/dashboards#/view/123`, you'll see a helpful toast message +indicating that the dashboard has a new URL, and you'll automatically get redirected to +`http://localhost:5601/s/bills-space/app/dashboards#/view/456`. + +[[legacy-url-aliases-handling-errors]] +=== Handling errors + +Legacy URL aliases are intended to be fully transparent, but there are some very rare situations where this can lead to an error. For +example, you may have a dashboard and one of the visualizations may fail to load, directing you to this page. If you encounter an error +in this situation, you might want to disable the legacy URL alias completely. This leaves the saved object intact and you will not lose any +data by disabling the alias -- you just won't be able to use the old URL to access that saved object anymore. + +To disable a legacy URL alias, you'll need three pieces of information about it: the `targetSpace`, the `targetType`, and the `sourceId`. +Once you have this information, you can use the <> API to disable the +problematic legacy URL alias. From a52d5f6cf8889125e614dc6c3e7b5369286153c2 Mon Sep 17 00:00:00 2001 From: Joe Portner <5295965+jportner@users.noreply.github.com> Date: Thu, 26 Aug 2021 12:25:14 -0400 Subject: [PATCH 2/7] Fix Disable legacy URL aliases API docs --- .../disable_legacy_url_aliases.asciidoc | 31 +++++++++++++------ 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc b/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc index 9b54b9c1b7f6d..8b05fa656ebea 100644 --- a/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc +++ b/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc @@ -1,5 +1,5 @@ [[spaces-api-disable-legacy-url-aliases]] -=== Create space API +=== Disable legacy URL aliases API ++++ Disable legacy URL aliases ++++ @@ -14,14 +14,21 @@ experimental[] Disable a <> in {kib}. [[spaces-api-disable-legacy-url-aliases-request-body]] ==== Request body -`targetSpace`:: - (Required, string) The space where the alias target object exists. +`aliases`:: + (Required, object array) The aliases to disable. ++ +.Properties of `aliases` +[%collapsible%open] +===== + `targetSpace`:: + (Required, string) The space where the alias target object exists. -`targetType`:: - (Required, string) The type of the alias target object. + `targetType`:: + (Required, string) The type of the alias target object. -`sourceId`:: - (Required, string) The ID of the alias source object. This is the "legacy" object ID. + `sourceId`:: + (Required, string) The ID of the alias source object. This is the "legacy" object ID. +===== [[spaces-api-disable-legacy-url-aliases-response-codes]] ==== Response codes @@ -36,9 +43,13 @@ experimental[] Disable a <> in {kib}. -------------------------------------------------- $ curl -X POST api/spaces/_disable_legacy_url_aliases { - "targetSpace": "bills-space", - "targetType": "dashboard", - "sourceId": "123" + "aliases": [ + { + "targetSpace": "bills-space", + "targetType": "dashboard", + "sourceId": "123" + } + ] } -------------------------------------------------- // KIBANA From 09d46ff07b89e427ec0c8a063a768e4495700bd9 Mon Sep 17 00:00:00 2001 From: Joe Portner <5295965+jportner@users.noreply.github.com> Date: Thu, 26 Aug 2021 12:30:05 -0400 Subject: [PATCH 3/7] Include disable_legacy_url_aliases doc --- docs/api/spaces-management.asciidoc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/api/spaces-management.asciidoc b/docs/api/spaces-management.asciidoc index 2e3b9abec9120..82ac4ce59ce8f 100644 --- a/docs/api/spaces-management.asciidoc +++ b/docs/api/spaces-management.asciidoc @@ -20,6 +20,8 @@ The following {kib} spaces APIs are available: * <> to overwrite saved objects returned as errors from the copy saved objects to space API +* <> to disable legacy URL aliases + include::spaces-management/post.asciidoc[] include::spaces-management/put.asciidoc[] include::spaces-management/get.asciidoc[] @@ -27,3 +29,4 @@ include::spaces-management/get_all.asciidoc[] include::spaces-management/delete.asciidoc[] include::spaces-management/copy_saved_objects.asciidoc[] include::spaces-management/resolve_copy_saved_objects_conflicts.asciidoc[] +include::spaces-management/disable_legacy_url_aliases.asciidoc[] From c1fea867d63fc6d2426dcdbe7df6b7e964f3963c Mon Sep 17 00:00:00 2001 From: Joe Portner <5295965+jportner@users.noreply.github.com> Date: Thu, 26 Aug 2021 14:02:47 -0400 Subject: [PATCH 4/7] PR review feedback --- .../advanced/legacy-url-aliases.asciidoc | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/developer/advanced/legacy-url-aliases.asciidoc b/docs/developer/advanced/legacy-url-aliases.asciidoc index 92d9aa2c30259..00f1645410804 100644 --- a/docs/developer/advanced/legacy-url-aliases.asciidoc +++ b/docs/developer/advanced/legacy-url-aliases.asciidoc @@ -6,19 +6,21 @@ This page describes legacy URL aliases: what they are, where they come from, and [[legacy-url-aliases-overview]] === Overview -Many saved object types are being converted in the 8.0 release of {kib} so they can eventually be shared across <>. -Before 8.0, you could have two objects with the same type and same ID in two different spaces. Part of this conversion is to make sure all -object IDs of a given type are *globally unique across all spaces*. +Many saved object types were converted in the 8.0 release of {kib} so they can eventually be shared across <>. Before +8.0, you could have two objects with the same type and same ID in two different spaces. Part of this conversion is to make sure all object +IDs of a given type are *globally unique across all spaces*. -When a saved object is converted, if its ID is changed, {kib} creates a special entity called a _legacy URL alias_. This allows us to -preserve any deep link URLs that may exist for that object. +{kib} creates a special entity called a **legacy URL alias** for each saved object that requires a new ID. This legacy URL alias allows +{kib} to preserve any deep link URLs that may exist for these objects. [[legacy-url-aliases-example]] === Example For example, consider the following scenario: -You have {kib} 7.16 installed and you created a new dashboard. This dashboard's ID is "123". Then, you create a new space called "Bill's space", and copy your dashboard to the other space. Now you have two different dashboards that can be accessed at the following URLs: +You have {kib} 7.16 installed and you created a new dashboard. This dashboard's ID is "123". Then, you create a new space called "Bill's +space", and <>. Now you have two different dashboards that can +be accessed at the following URLs: * *Default space*: `http://localhost:5601/app/dashboards#/view/123` * *Bill's space*: `http://localhost:5601/s/bills-space/app/dashboards#/view/123` @@ -28,9 +30,8 @@ You use these two dashboards frequently, so you use your web browser to add book to access that dashboard is different -- not to worry though, there is a legacy URL alias for that dashboard! If you use your bookmark to access that dashboard using its old URL, {kib} detects that you are using a legacy URL and it finds the new -object ID. This means if you navigate to `http://localhost:5601/s/bills-space/app/dashboards#/view/123`, you'll see a helpful toast message -indicating that the dashboard has a new URL, and you'll automatically get redirected to -`http://localhost:5601/s/bills-space/app/dashboards#/view/456`. +object ID. This means if you navigate to `http://localhost:5601/s/bills-space/app/dashboards#/view/123`, you'll see a message indicating +that the dashboard has a new URL, and you'll automatically get redirected to `http://localhost:5601/s/bills-space/app/dashboards#/view/456`. [[legacy-url-aliases-handling-errors]] === Handling errors From 3586f3cdc6d67cf5d9f48a4fc5fc084513b6165c Mon Sep 17 00:00:00 2001 From: Joe Portner <5295965+jportner@users.noreply.github.com> Date: Mon, 30 Aug 2021 12:38:01 -0400 Subject: [PATCH 5/7] More PR review feedback --- docs/api/spaces-management.asciidoc | 2 +- .../disable_legacy_url_aliases.asciidoc | 11 +++--- .../advanced/legacy-url-aliases.asciidoc | 34 +++++++++---------- 3 files changed, 23 insertions(+), 24 deletions(-) diff --git a/docs/api/spaces-management.asciidoc b/docs/api/spaces-management.asciidoc index 82ac4ce59ce8f..333a06cf3754e 100644 --- a/docs/api/spaces-management.asciidoc +++ b/docs/api/spaces-management.asciidoc @@ -20,7 +20,7 @@ The following {kib} spaces APIs are available: * <> to overwrite saved objects returned as errors from the copy saved objects to space API -* <> to disable legacy URL aliases +* <> to disable legacy URL aliases if an error is encountered include::spaces-management/post.asciidoc[] include::spaces-management/put.asciidoc[] diff --git a/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc b/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc index 8b05fa656ebea..73dfcc3b26c06 100644 --- a/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc +++ b/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc @@ -20,13 +20,13 @@ experimental[] Disable a <> in {kib}. .Properties of `aliases` [%collapsible%open] ===== - `targetSpace`:: + `targetSpace`::: (Required, string) The space where the alias target object exists. - `targetType`:: + `targetType`::: (Required, string) The type of the alias target object. - `sourceId`:: + `sourceId`::: (Required, string) The ID of the alias source object. This is the "legacy" object ID. ===== @@ -54,6 +54,5 @@ $ curl -X POST api/spaces/_disable_legacy_url_aliases -------------------------------------------------- // KIBANA -This will leave the alias intact, but the legacy URL for this alias will no longer function. In this example, you had a legacy URL for -`http://localhost:5601/s/bills-space/app/dashboards#/view/123`. That URL would no longer work after making this API call, but the dashboard -itself still exists and can be accessed by its new URL. \ No newline at end of file +This example leaves the alias intact, but the legacy URL for this alias, http://localhost:5601/s/bills-space/app/dashboards#/view/123, will +no longer function. The dashboard still exists, and you can access it with the new URL. \ No newline at end of file diff --git a/docs/developer/advanced/legacy-url-aliases.asciidoc b/docs/developer/advanced/legacy-url-aliases.asciidoc index 00f1645410804..973839aa987ec 100644 --- a/docs/developer/advanced/legacy-url-aliases.asciidoc +++ b/docs/developer/advanced/legacy-url-aliases.asciidoc @@ -6,41 +6,41 @@ This page describes legacy URL aliases: what they are, where they come from, and [[legacy-url-aliases-overview]] === Overview -Many saved object types were converted in the 8.0 release of {kib} so they can eventually be shared across <>. Before +Many saved object types were converted in {kib} 8.0, so they can eventually be shared across <>. Before 8.0, you could have two objects with the same type and same ID in two different spaces. Part of this conversion is to make sure all object IDs of a given type are *globally unique across all spaces*. {kib} creates a special entity called a **legacy URL alias** for each saved object that requires a new ID. This legacy URL alias allows -{kib} to preserve any deep link URLs that may exist for these objects. +{kib} to preserve any deep link URLs that exist for these objects. [[legacy-url-aliases-example]] === Example -For example, consider the following scenario: +Consider the following scenario: -You have {kib} 7.16 installed and you created a new dashboard. This dashboard's ID is "123". Then, you create a new space called "Bill's -space", and <>. Now you have two different dashboards that can +You have {kib} 7.16, and you create a new dashboard.The ID of this dashboard is "123". You create a new space called "Bill's +space" and <> your dashboard to the other space. Now you have two different dashboards that can be accessed at the following URLs: * *Default space*: `http://localhost:5601/app/dashboards#/view/123` * *Bill's space*: `http://localhost:5601/s/bills-space/app/dashboards#/view/123` -You use these two dashboards frequently, so you use your web browser to add bookmarks for them. After some time, you decide upgrade to {kib} -8.0. When these two dashboards go through the conversion process, the one in "Bill's space" will have its ID changed to "456". Now, the URL -to access that dashboard is different -- not to worry though, there is a legacy URL alias for that dashboard! +You use these two dashboards frequently, so you bookmark them in your web browser. After some time, you decide upgrade to {kib} +8.0. When these two dashboards go through the conversion process, the one in "Bill's space" will have its ID changed to "456". The URL +to access that dashboard is different -- not to worry though, there is a legacy URL alias for that dashboard. -If you use your bookmark to access that dashboard using its old URL, {kib} detects that you are using a legacy URL and it finds the new -object ID. This means if you navigate to `http://localhost:5601/s/bills-space/app/dashboards#/view/123`, you'll see a message indicating -that the dashboard has a new URL, and you'll automatically get redirected to `http://localhost:5601/s/bills-space/app/dashboards#/view/456`. +If you use your bookmark to access that dashboard using its old URL, {kib} detects that you are using a legacy URL, and finds the new +object ID. If you navigate to `http://localhost:5601/s/bills-space/app/dashboards#/view/123`, you'll see a message indicating +that the dashboard has a new URL, and you're automatically redirected to `http://localhost:5601/s/bills-space/app/dashboards#/view/456`. [[legacy-url-aliases-handling-errors]] === Handling errors -Legacy URL aliases are intended to be fully transparent, but there are some very rare situations where this can lead to an error. For -example, you may have a dashboard and one of the visualizations may fail to load, directing you to this page. If you encounter an error -in this situation, you might want to disable the legacy URL alias completely. This leaves the saved object intact and you will not lose any -data by disabling the alias -- you just won't be able to use the old URL to access that saved object anymore. +Legacy URL aliases are intended to be fully transparent, but there are rare situations where this can lead to an error. For +example, you might have a dashboard and one of the visualizations fails to load, directing you to this page. If you encounter an error +in this situation, you might want to disable the legacy URL alias completely. This leaves the saved object intact, and you will not lose any +data -- you just won't be able to use the old URL to access that saved object. -To disable a legacy URL alias, you'll need three pieces of information about it: the `targetSpace`, the `targetType`, and the `sourceId`. -Once you have this information, you can use the <> API to disable the +To disable a legacy URL alias, you need three pieces of information: the `targetSpace`, the `targetType`, and the `sourceId`. +Then use the <> API to disable the problematic legacy URL alias. From c88f04168d3208940daff26bf17511ccd2b72e56 Mon Sep 17 00:00:00 2001 From: Joe Portner <5295965+jportner@users.noreply.github.com> Date: Mon, 30 Aug 2021 12:38:42 -0400 Subject: [PATCH 6/7] Reformat line breaks --- .../advanced/legacy-url-aliases.asciidoc | 37 +++++++++---------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/docs/developer/advanced/legacy-url-aliases.asciidoc b/docs/developer/advanced/legacy-url-aliases.asciidoc index 973839aa987ec..fad2d0ef12db2 100644 --- a/docs/developer/advanced/legacy-url-aliases.asciidoc +++ b/docs/developer/advanced/legacy-url-aliases.asciidoc @@ -6,9 +6,9 @@ This page describes legacy URL aliases: what they are, where they come from, and [[legacy-url-aliases-overview]] === Overview -Many saved object types were converted in {kib} 8.0, so they can eventually be shared across <>. Before -8.0, you could have two objects with the same type and same ID in two different spaces. Part of this conversion is to make sure all object -IDs of a given type are *globally unique across all spaces*. +Many saved object types were converted in {kib} 8.0, so they can eventually be shared across <>. Before 8.0, you could +have two objects with the same type and same ID in two different spaces. Part of this conversion is to make sure all object IDs of a given +type are *globally unique across all spaces*. {kib} creates a special entity called a **legacy URL alias** for each saved object that requires a new ID. This legacy URL alias allows {kib} to preserve any deep link URLs that exist for these objects. @@ -18,29 +18,28 @@ IDs of a given type are *globally unique across all spaces*. Consider the following scenario: -You have {kib} 7.16, and you create a new dashboard.The ID of this dashboard is "123". You create a new space called "Bill's -space" and <> your dashboard to the other space. Now you have two different dashboards that can -be accessed at the following URLs: +You have {kib} 7.16, and you create a new dashboard.The ID of this dashboard is "123". You create a new space called "Bill's space" and +<> your dashboard to the other space. Now you have two different dashboards that can be accessed +at the following URLs: * *Default space*: `http://localhost:5601/app/dashboards#/view/123` * *Bill's space*: `http://localhost:5601/s/bills-space/app/dashboards#/view/123` -You use these two dashboards frequently, so you bookmark them in your web browser. After some time, you decide upgrade to {kib} -8.0. When these two dashboards go through the conversion process, the one in "Bill's space" will have its ID changed to "456". The URL -to access that dashboard is different -- not to worry though, there is a legacy URL alias for that dashboard. +You use these two dashboards frequently, so you bookmark them in your web browser. After some time, you decide upgrade to {kib} 8.0. When +these two dashboards go through the conversion process, the one in "Bill's space" will have its ID changed to "456". The URL to access that +dashboard is different -- not to worry though, there is a legacy URL alias for that dashboard. -If you use your bookmark to access that dashboard using its old URL, {kib} detects that you are using a legacy URL, and finds the new -object ID. If you navigate to `http://localhost:5601/s/bills-space/app/dashboards#/view/123`, you'll see a message indicating -that the dashboard has a new URL, and you're automatically redirected to `http://localhost:5601/s/bills-space/app/dashboards#/view/456`. +If you use your bookmark to access that dashboard using its old URL, {kib} detects that you are using a legacy URL, and finds the new object +ID. If you navigate to `http://localhost:5601/s/bills-space/app/dashboards#/view/123`, you'll see a message indicating that the dashboard +has a new URL, and you're automatically redirected to `http://localhost:5601/s/bills-space/app/dashboards#/view/456`. [[legacy-url-aliases-handling-errors]] === Handling errors -Legacy URL aliases are intended to be fully transparent, but there are rare situations where this can lead to an error. For -example, you might have a dashboard and one of the visualizations fails to load, directing you to this page. If you encounter an error -in this situation, you might want to disable the legacy URL alias completely. This leaves the saved object intact, and you will not lose any -data -- you just won't be able to use the old URL to access that saved object. +Legacy URL aliases are intended to be fully transparent, but there are rare situations where this can lead to an error. For example, you +might have a dashboard and one of the visualizations fails to load, directing you to this page. If you encounter an error in this situation, +you might want to disable the legacy URL alias completely. This leaves the saved object intact, and you will not lose any data -- you just +won't be able to use the old URL to access that saved object. -To disable a legacy URL alias, you need three pieces of information: the `targetSpace`, the `targetType`, and the `sourceId`. -Then use the <> API to disable the -problematic legacy URL alias. +To disable a legacy URL alias, you need three pieces of information: the `targetSpace`, the `targetType`, and the `sourceId`. Then use the +<> API to disable the problematic legacy URL alias. From 2600785c231fe4e53bec7e36a8bb1aae2b0adb03 Mon Sep 17 00:00:00 2001 From: Joe Portner <5295965+jportner@users.noreply.github.com> Date: Mon, 30 Aug 2021 13:15:01 -0400 Subject: [PATCH 7/7] More edits --- .../disable_legacy_url_aliases.asciidoc | 9 +++++---- docs/developer/advanced/legacy-url-aliases.asciidoc | 2 +- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc b/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc index 73dfcc3b26c06..3f713d9d0c25e 100644 --- a/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc +++ b/docs/api/spaces-management/disable_legacy_url_aliases.asciidoc @@ -7,12 +7,13 @@ experimental[] Disable a <> in {kib}. [[spaces-api-disable-legacy-url-aliases-request]] -==== Request +==== {api-request-title} `POST :/api/spaces/_disable_legacy_url_aliases` +[role="child_attributes"] [[spaces-api-disable-legacy-url-aliases-request-body]] -==== Request body +==== {api-request-body-title} `aliases`:: (Required, object array) The aliases to disable. @@ -31,13 +32,13 @@ experimental[] Disable a <> in {kib}. ===== [[spaces-api-disable-legacy-url-aliases-response-codes]] -==== Response codes +==== {api-response-codes-title} `204`:: Indicates a successful call. [[spaces-api-disable-legacy-url-aliases-example]] -==== Example +==== {api-examples-title} [source,sh] -------------------------------------------------- diff --git a/docs/developer/advanced/legacy-url-aliases.asciidoc b/docs/developer/advanced/legacy-url-aliases.asciidoc index fad2d0ef12db2..3e441dd582123 100644 --- a/docs/developer/advanced/legacy-url-aliases.asciidoc +++ b/docs/developer/advanced/legacy-url-aliases.asciidoc @@ -25,7 +25,7 @@ at the following URLs: * *Default space*: `http://localhost:5601/app/dashboards#/view/123` * *Bill's space*: `http://localhost:5601/s/bills-space/app/dashboards#/view/123` -You use these two dashboards frequently, so you bookmark them in your web browser. After some time, you decide upgrade to {kib} 8.0. When +You use these two dashboards frequently, so you bookmark them in your web browser. After some time, you decide to upgrade to {kib} 8.0. When these two dashboards go through the conversion process, the one in "Bill's space" will have its ID changed to "456". The URL to access that dashboard is different -- not to worry though, there is a legacy URL alias for that dashboard.