Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add new parameter to Clear Index Cache API #4132

Merged
merged 9 commits into from
May 30, 2023
Merged

Add new parameter to Clear Index Cache API #4132

merged 9 commits into from
May 30, 2023

Conversation

hdhalter
Copy link
Collaborator

@hdhalter hdhalter commented May 19, 2023 •
edited

Description

Describe what this change achieves.

Issues Resolved

fixes #4092

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.

@hdhalter
clearcacheAPI
b321c18 
Signed-off-by: Heather Halter <hdhalter@amazon.com>
@hdhalter hdhalter self-assigned this May 19, 2023
@hdhalter hdhalter added the 3 - Tech Review PR: Tech review in progress label May 19, 2023
Naarcha-AWS
Naarcha-AWS approved these changes May 22, 2023
View reviewed changes
Copy link
Collaborator

@Naarcha-AWS Naarcha-AWS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing an extra tick mark from the code example, otherwise, LGTM.

_api-reference/index-apis/clear-index-cache.md Outdated Show resolved Hide resolved
_api-reference/index-apis/clear-index-cache.md Outdated Show resolved Hide resolved
hdhalter and others added 2 commits May 22, 2023 10:22
@hdhalter @Naarcha-AWS
Update _api-reference/index-apis/clear-index-cache.md
81c8653 
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
@hdhalter @Naarcha-AWS
Update _api-reference/index-apis/clear-index-cache.md
ea1fafd 
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
@hdhalter
Copy link
Collaborator Author

@kotwanikunal - Hi Kunal, can you please check this for technical accuracy? Thanks.

@kotwanikunal
Copy link
Member

@kotwanikunal - Hi Kunal, can you please check this for technical accuracy? Thanks.

LGTM! Thanks 👍

@hdhalter hdhalter added 5 - Final Editorial Review PR: Editorial Review in progress and removed 3 - Tech Review PR: Tech review in progress labels May 22, 2023
natebower
natebower requested changes May 23, 2023
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hdhalter Just a couple of comments to be addressed. Please tag me when complete.

_api-reference/index-apis/clear-index-cache.md Outdated Show resolved Hide resolved
@natebower natebower removed the 5 - Final Editorial Review PR: Editorial Review in progress label May 23, 2023
@hdhalter
editsfromteam
ffd0052 
Signed-off-by: Heather Halter <hdhalter@amazon.com>
@hdhalter
fixedtickmarks
e6f9236 
Signed-off-by: Heather Halter <hdhalter@amazon.com>
@hdhalter
fixedheadings
b17301d 
Signed-off-by: Heather Halter <hdhalter@amazon.com>
@hdhalter
Copy link
Collaborator Author

@natebower - ready for re-review. @kolchfa-aws - can you also give it a check? I fixed the formatting on the example requests and the headings (they were inconsistent with the rest of the index API files). Thanks!

@hdhalter hdhalter added the 4 - Doc Review PR: Doc review in progress label May 23, 2023
natebower
natebower reviewed May 23, 2023
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hdhalter A couple more comments.

_api-reference/index-apis/clear-index-cache.md Outdated Show resolved Hide resolved
_api-reference/index-apis/clear-index-cache.md Outdated Show resolved Hide resolved
@hdhalter
Copy link
Collaborator Author

@kotwanikunal - Is there any reason not to call this topic "Clear cache" to keep consistent with the other topics?

The first sentence says, "The clear cache API operation clears the caches of one or more indexes. For data streams, the API clears the caches of the stream’s backing indexes."

@hdhalter
fixheadings
05b9361 
Signed-off-by: Heather Halter <hdhalter@amazon.com>
@hdhalter
add-or
618c8b3 
Signed-off-by: Heather Halter <hdhalter@amazon.com>
@kotwanikunal
Copy link
Member

@kotwanikunal - Is there any reason not to call this topic "Clear cache" to keep consistent with the other topics?

The first sentence says, "The clear cache API operation clears the caches of one or more indexes. For data streams, the API clears the caches of the stream’s backing indexes."

File cache is a new and separate entity from the existing cache. We need to use it specifically in this context to make it clear which cache the user intends to clear.

@hdhalter
Copy link
Collaborator Author

@kotwanikunal - Would it be correct to say, "The clear cache API operation clears the caches of indexes, data streams, and files. For data streams, the API clears the caches of the stream’s backing indexes."

@hdhalter
Copy link
Collaborator Author

hdhalter commented May 23, 2023 •
edited

Kunal is good with how it is. @Naarcha-AWS - do you want to take another pass? I changed the name of the topic to "Clear cache". Oops, I meant to tag @natebower. : )

@hdhalter hdhalter added v2.8.0 release-notes PR: Include this PR in the automated release notes 5 - Final Editorial Review PR: Editorial Review in progress and removed 4 - Doc Review PR: Doc review in progress labels May 23, 2023
natebower
natebower approved these changes May 30, 2023
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@natebower natebower removed the 5 - Final Editorial Review PR: Editorial Review in progress label May 30, 2023
@hdhalter
Merge branch 'main' into clear-index-feature
becb558 
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
@hdhalter hdhalter merged commit ad2c693 into main May 30, 2023
4 checks passed
@hdhalter hdhalter changed the title Adds new parameter to Clear Index Cache API Add new parameter to Clear Index Cache API Jun 1, 2023
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
@hdhalter @Naarcha-AWS @harshavamsi
Adds new parameter to Clear Index Cache API (opensearch-project#4132)
67cc59f 
* clearcacheAPI

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* Update _api-reference/index-apis/clear-index-cache.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/clear-index-cache.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* editsfromteam

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fixedtickmarks

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fixedheadings

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fixheadings

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* add-or

Signed-off-by: Heather Halter <hdhalter@amazon.com>

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@hdhalter hdhalter deleted the clear-index-feature branch March 28, 2024 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kotwanikunal kotwanikunal kotwanikunal approved these changes

@kolchfa-aws kolchfa-aws kolchfa-aws left review comments

@Naarcha-AWS Naarcha-AWS Naarcha-AWS approved these changes

@natebower natebower natebower approved these changes

@cwillum cwillum Awaiting requested review from cwillum

@vagimeli vagimeli Awaiting requested review from vagimeli vagimeli is a code owner

@ananzh ananzh Awaiting requested review from ananzh

@seanneumann seanneumann Awaiting requested review from seanneumann

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

Assignees

@hdhalter hdhalter

Labels
release-notes PR: Include this PR in the automated release notes v2.8.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] New file option for Clear Index Cache API
5 participants
@hdhalter @kotwanikunal @Naarcha-AWS @natebower @kolchfa-aws