Skip to content

Commit

Permalink
Update update-alias.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@Naarcha-AWS
Naarcha-AWS authored Jul 15, 2024
1 parent 816df4e commit 7b1c88a
Showing 1 changed file with 14 additions and 16 deletions.
30 changes: 14 additions & 16 deletions _api-reference/index-apis/update-alias.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,9 @@ nav_order: 5
**Introduced 1.0**
{: .label .label-purple }

The Create or Update Alias API adds a data stream or index to an alias or updates the settings for an existing alias.
The Create or update alias API adds a data stream or index to an alias or updates the settings for an existing alias. For more Alias API operations, see [Index aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias/).


## Example

```json
POST sample-index/_alias/sample-alias
```

```json
POST sample-index/_alias/sample-alias
{
"routing":"test"
}
```
{% include copy-curl.html %}

## Path and HTTP methods

```
Expand Down Expand Up @@ -72,7 +58,19 @@ Field | Type | Description
`search_routing` | String | Assigns a custom value to a shard only for search operations.
`filter` | Object | A filter to use with the alias, so the alias points to a filtered part of the index.

## Response
## Example request

The following example request adss a sample alias with a custom routing value:

Check failure on line 63 in _api-reference/index-apis/update-alias.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: adss. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: adss. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_api-reference/index-apis/update-alias.md", "range": {"start": {"line": 63, "column": 31}}}, "severity": "ERROR"}

```json
POST sample-index/_alias/sample-alias
{
"routing":"test"
}
```
{% include copy-curl.html %}

## Example response

```json
{
Expand Down

0 comments on commit 7b1c88a

Please sign in to comment.