From 080f467bc729f0c60d830babb4067932e671ed1f Mon Sep 17 00:00:00 2001
From: Archer <naarcha@amazon.com>
Date: Tue, 2 Jul 2024 10:50:26 -0500
Subject: [PATCH 1/3] Add Resolve API

Signed-off-by: Archer <naarcha@amazon.com>
---
 _api-reference/index-apis/resolve.md | 94 ++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 _api-reference/index-apis/resolve.md

diff --git a/_api-reference/index-apis/resolve.md b/_api-reference/index-apis/resolve.md
new file mode 100644
index 0000000000..a4e0fb1294
--- /dev/null
+++ b/_api-reference/index-apis/resolve.md
@@ -0,0 +1,94 @@
+---
+layout: default
+title: Resolve index
+parent: Index APIs
+nav_order: 63
+---
+
+# Resolve index
+
+Introduced 1.0
+{: .label .label-purple }
+
+The Resolve Index API lists the indexes, aliases, and data streams based on the specified name. Multiple patterns and remote clusters are supported.
+
+## Path and HTTP methods
+
+The Resolve Index API supports the following API method:
+
+```
+GET /_resolve/index/<name>
+```
+{% include copy-curl.html %}
+
+## Permissions
+
+When OpenSearch Security is enabled, you must have the `view_index_metadata` or `manage` index permissions for the target data stream, index, or index alias. <!-----FOLLOW UP, Is there a distinction between index permissions and index privileges?>
+
+## Path parameters
+
+The following table lists the available path parameters. All path parameters are optional.
+
+| Parameter | Data type | Description |
+| :--- | :--- | :--- |
+| `<index>` | String | A comma-separated list of indexes, data streams, or index aliases to which the operation is applied. Supports wildcard expressions (`*`). Use `_all` or `*` to specify all indexes and data streams in a cluster. |
+
+## Query parameters
+
+The Resolve Index API supports the following optional query parameters:
+
+Parameter | Type | Description
+:--- | :--- | :---
+`allow_no_indices` | Boolean | Whether to ignore wildcards that don’t match any indexes. Default is `true`.
+allow_partial_search_results | Boolean | Whether to return partial results if the request runs into an error or times out. Default is `true`.
+`expand_wildcards` | String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Valid values are `all` (match any index), `open` (match open, non-hidden indexes), `closed` (match closed, non-hidden indexes), `hidden` (match hidden indexes), and `none` (deny wildcard expressions). Default is `open`.
+`ignore_unavailable` |  Boolean | Specifies whether to include missing or closed indexes in the response and ignores unavailable shards during the search request. Default is `false`.
+`ignore_throttled` | Boolean | Whether to ignore concrete, expanded, or indexes with aliases if indexes are frozen. Default is `true`.
+
+## Example Request
+
+The following example lists all indexes that start with the letter `h`, from a remote cluster named `bar`, with all wildcards expanded:
+
+```
+GET /_resolve/index/h*,remoteCluster1:bar*?expand_wildcards=all
+```
+
+## Example response
+
+The response lists each index, alias, and data stream matching the expression, as shown in the following example:
+
+```
+{
+  "indices": [
+    {
+      "name": "hamlet",
+      "attributes": [
+        "open"
+      ]
+    }
+  ],
+  "aliases": [                                 
+    {
+      "name": "h-alias",
+      "indices": [
+        "freeze-index",
+        "my-index-000001"
+      ]
+    }
+  ],
+  "data_streams": [                            
+    {
+      "name": "ham",
+      "backing_indices": [
+        ".ds-ham-2099.02.06-000001"
+      ],
+      "timestamp_field": "@timestamp"
+    }
+  ]
+}
+```
+
+The response lists each index, alias, and data stream matching the expression.
+
+
+

From 629d2a118fb1b811ecd450356ed46afd9e531b3b Mon Sep 17 00:00:00 2001
From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Date: Mon, 15 Jul 2024 11:38:42 -0500
Subject: [PATCH 2/3] Update _api-reference/index-apis/resolve.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
---
 _api-reference/index-apis/resolve.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/_api-reference/index-apis/resolve.md b/_api-reference/index-apis/resolve.md
index a4e0fb1294..1e09026753 100644
--- a/_api-reference/index-apis/resolve.md
+++ b/_api-reference/index-apis/resolve.md
@@ -45,7 +45,7 @@ allow_partial_search_results | Boolean | Whether to return partial results if th
 `ignore_unavailable` |  Boolean | Specifies whether to include missing or closed indexes in the response and ignores unavailable shards during the search request. Default is `false`.
 `ignore_throttled` | Boolean | Whether to ignore concrete, expanded, or indexes with aliases if indexes are frozen. Default is `true`.
 
-## Example Request
+## Example request
 
 The following example lists all indexes that start with the letter `h`, from a remote cluster named `bar`, with all wildcards expanded:
 

From 89bf46a49b53ea5d6c3763e5cd03143b7286169e Mon Sep 17 00:00:00 2001
From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Date: Wed, 24 Jul 2024 11:47:21 -0500
Subject: [PATCH 3/3] Apply suggestions from code review

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
---
 _api-reference/index-apis/resolve.md | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/_api-reference/index-apis/resolve.md b/_api-reference/index-apis/resolve.md
index 1e09026753..7218098698 100644
--- a/_api-reference/index-apis/resolve.md
+++ b/_api-reference/index-apis/resolve.md
@@ -35,19 +35,19 @@ The following table lists the available path parameters. All path parameters are
 
 ## Query parameters
 
-The Resolve Index API supports the following optional query parameters:
+The following table lists the available query parameters. All query parameters are optional.
 
-Parameter | Type | Description
+Parameter | Data type | Description
 :--- | :--- | :---
 `allow_no_indices` | Boolean | Whether to ignore wildcards that don’t match any indexes. Default is `true`.
-allow_partial_search_results | Boolean | Whether to return partial results if the request runs into an error or times out. Default is `true`.
+`allow_partial_search_results` | Boolean | Whether to return partial results if the request runs into an error or times out. Default is `true`.
 `expand_wildcards` | String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Valid values are `all` (match any index), `open` (match open, non-hidden indexes), `closed` (match closed, non-hidden indexes), `hidden` (match hidden indexes), and `none` (deny wildcard expressions). Default is `open`.
 `ignore_unavailable` |  Boolean | Specifies whether to include missing or closed indexes in the response and ignores unavailable shards during the search request. Default is `false`.
 `ignore_throttled` | Boolean | Whether to ignore concrete, expanded, or indexes with aliases if indexes are frozen. Default is `true`.
 
 ## Example request
 
-The following example lists all indexes that start with the letter `h`, from a remote cluster named `bar`, with all wildcards expanded:
+The following example lists all indexes that start with the letter `h`, are from a remote cluster named `bar`, and has all wildcards expanded:
 
 ```
 GET /_resolve/index/h*,remoteCluster1:bar*?expand_wildcards=all
@@ -55,7 +55,7 @@ GET /_resolve/index/h*,remoteCluster1:bar*?expand_wildcards=all
 
 ## Example response
 
-The response lists each index, alias, and data stream matching the expression, as shown in the following example:
+The following response lists each index, alias, and data stream matching the expression:
 
 ```
 {
@@ -88,7 +88,6 @@ The response lists each index, alias, and data stream matching the expression, a
 }
 ```
 
-The response lists each index, alias, and data stream matching the expression.