Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
  • Loading branch information
Naarcha-AWS and hdhalter authored Jul 24, 2024
1 parent 629d2a1 commit 89bf46a
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions _api-reference/index-apis/resolve.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,27 +35,27 @@ 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
```

## 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:

```
{
Expand Down Expand Up @@ -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.



0 comments on commit 89bf46a

Please sign in to comment.