Add the documentation of create or update alias API #7641

gaobinlong · 2024-07-08T06:22:19Z

Description

Document the usage of the create or update alias API, which was introduced in 1.0.

Issues Resolved

Version

All versions.

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: gaobinlong <gbinlong@amazon.com>

_api-reference/index-apis/update-alias.md

Signed-off-by: gaobinlong <gbinlong@amazon.com>

gaobinlong · 2024-07-09T14:59:58Z

@Naarcha-AWS Thanks for your review, I've modified the documentation yet, thank you!

Signed-off-by: gaobinlong <gbinlong@amazon.com>

Naarcha-AWS · 2024-07-18T15:23:30Z

@gaobinlong: I took another glance at the Index APIs and discovered we already have a page on aliases. https://opensearch.org/docs/latest/api-reference/index-apis/alias/

Do you want to add your changes on top of that page?

gaobinlong · 2024-07-19T01:03:08Z

@gaobinlong: I took another glance at the Index APIs and discovered we already have a page on aliases. https://opensearch.org/docs/latest/api-reference/index-apis/alias/

Do you want to add your changes on top of that page?

They are different APIs, actually there's some ambiguity between them, so this PR aims to eliminate the ambiguity.

Naarcha-AWS · 2024-07-19T17:53:51Z

@gaobinlong: Can you clarify the ambiguities?

Naarcha-AWS · 2024-07-20T13:29:24Z

Does the Aliases API allow you to perform alias actions versus this, which allows you to create them? Does that sound correct to you @gaobinlong?

gaobinlong · 2024-07-20T13:46:40Z

Does the Aliases API allow you to perform alias actions versus this, which allows you to create them? Does that sound correct to you @gaobinlong?

Aliases API supports add one or more alias, remove alias and remove index, but this API only supports add or update an alias, the http method, URL path and parameters of these two APIs are different, so I think they should be in different page.

Signed-off-by: gaobinlong <gbinlong@amazon.com>

gaobinlong · 2024-07-22T05:27:07Z

@Naarcha-AWS I've added some clarification in this document, please help to take a look, thank you!

Naarcha-AWS · 2024-07-23T14:33:15Z

Thanks @gaobinlong! I adjusted the format slightly. I'll go ahead and pass this into editorial review.

natebower

@gaobinlong @Naarcha-AWS Please see my comments and changes and tag me on lines 16 and 21 for approval when complete. Thanks!

natebower · 2024-07-23T15:06:57Z

_api-reference/index-apis/update-alias.md

@@ -0,0 +1,85 @@
+---
+layout: default
+title: Create or update alias


Should this be in title case if it's the name of the API?

natebower · 2024-07-23T15:07:05Z

_api-reference/index-apis/update-alias.md

+nav_order: 5
+---
+
+# Create or update alias


_api-reference/index-apis/update-alias.md

natebower · 2024-07-23T15:09:52Z

_api-reference/index-apis/update-alias.md

+
+## Path and HTTP methods
+
+```


Not for these. They are meant to be copy and pasted individually depending on what endpoint the user selects.

@Naarcha-AWS Based on the API template, shouldn't this have highlighting, though? @kolchfa-aws Can you verify?

Yes, even though the path and HTTP method are not part of JSON, we still have the json formatting tag on these for consistency.

_api-reference/index-apis/update-alias.md

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Signed-off-by: Nathan Bower <nbower@amazon.com>

natebower

LGTM

* Add the documentation of create or update alias API Signed-off-by: gaobinlong <gbinlong@amazon.com> * Fix typo Signed-off-by: gaobinlong <gbinlong@amazon.com> * Refine the wording Signed-off-by: gaobinlong <gbinlong@amazon.com> * Update update-alias.md * Fix typo Signed-off-by: gaobinlong <gbinlong@amazon.com> * Add some clarification Signed-off-by: gaobinlong <gbinlong@amazon.com> * Update update-alias.md * Update update-alias.md * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _api-reference/index-apis/update-alias.md Signed-off-by: Nathan Bower <nbower@amazon.com> --------- Signed-off-by: gaobinlong <gbinlong@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Nathan Bower <nbower@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit 06ef161) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…ct#7641) * Add the documentation of create or update alias API Signed-off-by: gaobinlong <gbinlong@amazon.com> * Fix typo Signed-off-by: gaobinlong <gbinlong@amazon.com> * Refine the wording Signed-off-by: gaobinlong <gbinlong@amazon.com> * Update update-alias.md * Fix typo Signed-off-by: gaobinlong <gbinlong@amazon.com> * Add some clarification Signed-off-by: gaobinlong <gbinlong@amazon.com> * Update update-alias.md * Update update-alias.md * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _api-reference/index-apis/update-alias.md Signed-off-by: Nathan Bower <nbower@amazon.com> --------- Signed-off-by: gaobinlong <gbinlong@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Nathan Bower <nbower@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

…ct#7641) * Add the documentation of create or update alias API Signed-off-by: gaobinlong <gbinlong@amazon.com> * Fix typo Signed-off-by: gaobinlong <gbinlong@amazon.com> * Refine the wording Signed-off-by: gaobinlong <gbinlong@amazon.com> * Update update-alias.md * Fix typo Signed-off-by: gaobinlong <gbinlong@amazon.com> * Add some clarification Signed-off-by: gaobinlong <gbinlong@amazon.com> * Update update-alias.md * Update update-alias.md * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _api-reference/index-apis/update-alias.md Signed-off-by: Nathan Bower <nbower@amazon.com> --------- Signed-off-by: gaobinlong <gbinlong@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Nathan Bower <nbower@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Sander van de Geijn <sandervandegeijn@icloud.com>

Add the documentation of create or update alias API

31ee8c6

Signed-off-by: gaobinlong <gbinlong@amazon.com>

gaobinlong requested review from hdhalter, kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower, dlvenable, stephen-crawford and epugh as code owners July 8, 2024 06:22

Naarcha-AWS self-assigned this Jul 8, 2024

Naarcha-AWS added API 4 - Doc review PR: Doc review in progress labels Jul 8, 2024

Merge remote-tracking branch 'upstream/main' into put_alias

169f48c

Naarcha-AWS requested changes Jul 9, 2024

View reviewed changes

gaobinlong added 2 commits July 9, 2024 22:43

Fix typo

a503655

Signed-off-by: gaobinlong <gbinlong@amazon.com>

Refine the wording

816df4e

Signed-off-by: gaobinlong <gbinlong@amazon.com>

hdhalter added the backport 2.15 label Jul 9, 2024

gaobinlong mentioned this pull request Jul 11, 2024

Fix create or update alias API doesn't throw exception for unsupported parameters opensearch-project/OpenSearch#14719

Merged

3 tasks

Naarcha-AWS and others added 3 commits July 15, 2024 18:23

Update update-alias.md

7b1c88a

Merge remote-tracking branch 'upstream/main' into put_alias

0e72127

Fix typo

89ca07e

Signed-off-by: gaobinlong <gbinlong@amazon.com>

Naarcha-AWS approved these changes Jul 18, 2024

View reviewed changes

Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jul 18, 2024

Merge branch 'main' into put_alias

c31c13f

Add some clarification

398c392

Signed-off-by: gaobinlong <gbinlong@amazon.com>

Update update-alias.md

c77f93f

natebower requested changes Jul 23, 2024

View reviewed changes

Update update-alias.md

448ef0b

Naarcha-AWS reviewed Jul 23, 2024

View reviewed changes

_api-reference/index-apis/update-alias.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Jul 23, 2024

View reviewed changes

_api-reference/index-apis/update-alias.md Outdated Show resolved Hide resolved

Naarcha-AWS and others added 2 commits July 23, 2024 12:33

Apply suggestions from code review

333d988

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Update _api-reference/index-apis/update-alias.md

3d13c84

Signed-off-by: Nathan Bower <nbower@amazon.com>

natebower approved these changes Jul 23, 2024

View reviewed changes

Merge branch 'main' into put_alias

7f8fefa

Naarcha-AWS merged commit 06ef161 into opensearch-project:main Jul 23, 2024
5 checks passed

opensearch-trigger-bot bot mentioned this pull request Jul 23, 2024

[Backport 2.15] Add the documentation of create or update alias API #7822

Merged

github-actions bot pushed a commit that referenced this pull request Jul 23, 2024

Add the documentation of create or update alias API (#7641) (#7822)

9be0354

gaobinlong mentioned this pull request Jul 24, 2024

Fix the documentation urls of alias related APIs opensearch-project/opensearch-api-specification#448

Merged

natebower mentioned this pull request Jul 24, 2024

Add Recovery API #7653

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add the documentation of create or update alias API #7641

Add the documentation of create or update alias API #7641

gaobinlong commented Jul 8, 2024 •

edited by hdhalter

Loading

gaobinlong commented Jul 9, 2024

Naarcha-AWS commented Jul 18, 2024

gaobinlong commented Jul 19, 2024

Naarcha-AWS commented Jul 19, 2024

Naarcha-AWS commented Jul 20, 2024

gaobinlong commented Jul 20, 2024 •

edited

Loading

gaobinlong commented Jul 22, 2024

Naarcha-AWS commented Jul 23, 2024

natebower left a comment

natebower Jul 23, 2024

natebower Jul 23, 2024

natebower Jul 23, 2024

Naarcha-AWS Jul 23, 2024

natebower Jul 24, 2024

kolchfa-aws Jul 24, 2024

natebower left a comment

Add the documentation of create or update alias API #7641

Add the documentation of create or update alias API #7641

Conversation

gaobinlong commented Jul 8, 2024 • edited by hdhalter Loading

Description

Issues Resolved

Version

Frontend features

Checklist

gaobinlong commented Jul 9, 2024

Naarcha-AWS commented Jul 18, 2024

gaobinlong commented Jul 19, 2024

Naarcha-AWS commented Jul 19, 2024

Naarcha-AWS commented Jul 20, 2024

gaobinlong commented Jul 20, 2024 • edited Loading

gaobinlong commented Jul 22, 2024

Naarcha-AWS commented Jul 23, 2024

natebower left a comment

Choose a reason for hiding this comment

natebower Jul 23, 2024

Choose a reason for hiding this comment

natebower Jul 23, 2024

Choose a reason for hiding this comment

natebower Jul 23, 2024

Choose a reason for hiding this comment

Naarcha-AWS Jul 23, 2024

Choose a reason for hiding this comment

natebower Jul 24, 2024

Choose a reason for hiding this comment

kolchfa-aws Jul 24, 2024

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

gaobinlong commented Jul 8, 2024 •

edited by hdhalter

Loading

gaobinlong commented Jul 20, 2024 •

edited

Loading