Add Refresh API #6954

Naarcha-AWS · 2024-04-15T17:22:00Z

Closes #2099

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: Archer <[email protected]>

epugh

not sure if this is a common pattern, but if someone lands on this page, how would they learn more about refreshing indexes and streams backed indices? If there is other content in the docs that would make sense to link to this page, it would be nice to see that.

hdhalter · 2024-04-22T23:37:05Z

not sure if this is a common pattern, but if someone lands on this page, how would they learn more about refreshing indexes and streams backed indices? If there is other content in the docs that would make sense to link to this page, it would be nice to see that.

Makes sense, @epugh, we definitely need to add some xrefs. Here is a link to refreshing indexes: https://opensearch.org/docs/latest/dashboards/im-dashboards/index-management/#refreshing-an-index.

hdhalter · 2024-05-06T16:57:25Z

@msfroh - Can you please review this for technical accuracy? Thanks!

hdhalter

Made a few tweaks to the wording.

_api-reference/index-apis/refresh.md

msfroh · 2024-05-06T19:24:38Z

_api-reference/index-apis/refresh.md

+nav_order: 61
+---
+
+# Example API 


Refresh API?

_api-reference/index-apis/refresh.md

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

Signed-off-by: Naarcha-AWS <[email protected]>

hdhalter

Thanks, @Naarcha-AWS ! To be consistent with the other index APIs, we should call this "refresh index".

_api-reference/index-apis/refresh.md

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

_api-reference/index-apis/refresh.md

hdhalter

Looks good with my 2 comments implemented. Thanks!

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

Signed-off-by: Naarcha-AWS <[email protected]>

natebower

@Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!

_api-reference/index-apis/refresh.md

natebower · 2024-05-15T15:10:48Z

_api-reference/index-apis/refresh.md

+- When set, indexes are refreshed based on the `index.refresh_interval` setting (in seconds). For more information about `index.refresh_interval`settings, see [Dynamic index-level index settings]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/index-settings/#dynamic-index-level-index-settings).
+- When not set, refreshes occur every second until the shard receives no search requests for at least the number set in the `index.search.idle.after` setting (in seconds). Default is 30 s. 
+
+After a shard goes idle, the indexes will not refresh until either the next search request or a refresh index API request is sent. The first search request on an idle shard will wait for the refresh operation to complete. 


"its" indexes will not refresh (instead of "the")?

_api-reference/index-apis/refresh.md

natebower · 2024-05-15T15:18:14Z

_api-reference/index-apis/refresh.md

+
+#### Example: Refresh all data streams or indexes in a cluster
+
+The following request refreshes all data streams and indexes in the cluster.


We use "data streams and indexes" here but "data streams or indexes" in the heading. Let's make consistent.

_api-reference/index-apis/refresh.md

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

natebower

LGTM

* Add refresh API. Signed-off-by: Archer <[email protected]> * Add Refresh API Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/refresh.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/refresh.md Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Add link Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit 103b4e2) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Add refresh API. * Add Refresh API * Apply suggestions from code review * Update _api-reference/index-apis/refresh.md * Update _api-reference/index-apis/refresh.md * Apply suggestions from code review * Apply suggestions from code review * Add link * Apply suggestions from code review * Apply suggestions from code review --------- (cherry picked from commit 103b4e2) Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Nathan Bower <[email protected]>

* Add Refresh API (#6954) * Add refresh API. Signed-off-by: Archer <[email protected]> * Add Refresh API Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/refresh.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/refresh.md Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Add link Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit 103b4e2) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Remove non-existent link for 1.3 Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Fanit Kolchina <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Nathan Bower <[email protected]>

Naarcha-AWS added 2 commits April 15, 2024 12:20

Add refresh API.

b8c37f2

Signed-off-by: Archer <[email protected]>

Add Refresh API

ee75cdd

Signed-off-by: Archer <[email protected]>

Naarcha-AWS requested review from hdhalter, kolchfa-aws, vagimeli, AMoo-Miki, natebower, dlvenable, stephen-crawford and epugh as code owners April 15, 2024 17:22

Naarcha-AWS self-assigned this Apr 15, 2024

Naarcha-AWS added 3 - Tech review PR: Tech review in progress backport 2.13 PR: Backport label for 2.13 backport 1.3 PR: Backport label for v1.3.x labels Apr 15, 2024

epugh reviewed Apr 15, 2024

View reviewed changes

hdhalter mentioned this pull request Apr 26, 2024

[DOC-META] Missing api documentation #3614

Open

4 tasks

hdhalter assigned msfroh May 6, 2024

hdhalter reviewed May 6, 2024

View reviewed changes

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

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

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

msfroh reviewed May 7, 2024

View reviewed changes

hdhalter added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels May 8, 2024

Naarcha-AWS commented May 10, 2024

View reviewed changes

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

Naarcha-AWS and others added 3 commits May 10, 2024 10:33

Apply suggestions from code review

2aa1332

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

Update _api-reference/index-apis/refresh.md

7499a01

Signed-off-by: Naarcha-AWS <[email protected]>

Update _api-reference/index-apis/refresh.md

e010d76

Signed-off-by: Naarcha-AWS <[email protected]>

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

Naarcha-AWS added the 4 - Doc review PR: Doc review in progress label May 14, 2024

hdhalter reviewed May 14, 2024

View reviewed changes

Naarcha-AWS commented May 14, 2024

View reviewed changes

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

Apply suggestions from code review

38fb2cc

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

hdhalter reviewed May 14, 2024

View reviewed changes

_api-reference/index-apis/refresh.md Show resolved Hide resolved

hdhalter reviewed May 14, 2024

View reviewed changes

Naarcha-AWS and others added 2 commits May 14, 2024 18:32

Apply suggestions from code review

e9bb2af

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

Add link

d8ea5e4

Signed-off-by: Naarcha-AWS <[email protected]>

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

natebower reviewed May 15, 2024

View reviewed changes

Naarcha-AWS commented May 15, 2024

View reviewed changes

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

Naarcha-AWS and others added 2 commits May 15, 2024 10:38

Apply suggestions from code review

7e28177

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

Apply suggestions from code review

2d8bbdd

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

natebower approved these changes May 15, 2024

View reviewed changes

Naarcha-AWS merged commit 103b4e2 into main May 15, 2024
7 checks passed

Naarcha-AWS deleted the refresh-api branch May 15, 2024 15:54

opensearch-trigger-bot bot mentioned this pull request May 15, 2024

[Backport 1.3] Add Refresh API #7165

Closed

opensearch-trigger-bot bot mentioned this pull request May 15, 2024

[Backport 2.13] Add Refresh API #7166

Merged

github-actions bot pushed a commit that referenced this pull request May 15, 2024

Add Refresh API (#6954) (#7166)

1b6a0fc

Naarcha-AWS added the backport 2.14 PR: Backport label for 2.14 label May 15, 2024

opensearch-trigger-bot bot mentioned this pull request May 15, 2024

[Backport 2.14] Add Refresh API #7167

Merged

kolchfa-aws mentioned this pull request May 16, 2024

Backport/backport 6954 to 1.3 #7174

Merged

1 task

This was referenced Jul 3, 2024

Added tests for _refresh. opensearch-project/opensearch-api-specification#374

Merged

Fix: expand_wildcards in _refresh API. #7620

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Refresh API #6954

Add Refresh API #6954

Naarcha-AWS commented Apr 15, 2024

epugh left a comment

hdhalter commented Apr 22, 2024

hdhalter commented May 6, 2024

hdhalter left a comment

msfroh May 6, 2024

hdhalter left a comment

hdhalter left a comment

natebower left a comment

natebower May 15, 2024

natebower May 15, 2024

natebower left a comment


		#### Example: Refresh all data streams or indexes in a cluster

		The following request refreshes all data streams and indexes in the cluster.

Add Refresh API #6954

Add Refresh API #6954

Conversation

Naarcha-AWS commented Apr 15, 2024

Checklist

epugh left a comment

Choose a reason for hiding this comment

hdhalter commented Apr 22, 2024

hdhalter commented May 6, 2024

hdhalter left a comment

Choose a reason for hiding this comment

msfroh May 6, 2024

Choose a reason for hiding this comment

hdhalter left a comment

Choose a reason for hiding this comment

hdhalter left a comment

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

natebower May 15, 2024

Choose a reason for hiding this comment

natebower May 15, 2024

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment