Skip to content

Adding allow_partial_search_results parameter to OpenPointInTime action #3155

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.

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

Merged
merged 2 commits into from
Nov 20, 2024

Conversation

pmpailis
Copy link
Contributor

allow_partial_search_results was made available for the OpenPointInTime request in elastic/elasticsearch#111516 but the specs weren't properly updated. This PR adds a new allow_partial_search_results parameter to the OpenPointInTime spec, which default to false, and specifies whether we should be lenient if a shard is missing when creating a point in time reference, or if we should throw.

Closes #3144

Copy link
Contributor

Following you can find the validation results for the API you have changed.

API Status Request Response
open_point_in_time 🟢 7/7 7/7

You can validate this API yourself by using the make validate target.

@pmpailis pmpailis marked this pull request as ready for review November 20, 2024 08:15
@pmpailis pmpailis requested a review from a team as a code owner November 20, 2024 08:15
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

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

Thank you! LGTM.

Comment on lines 50 to 53
},
"allow_partial_search_results": {
"type": "boolean",
"description": "Specifiy whether to tolerate shards missing from the point in time creation, or throw an exception if any shard is missing. (default: false)"
Copy link
Member

Choose a reason for hiding this comment

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

Adding the JSON spec change is a nice touch, thank you! The source of truth is still Elasticsearch, and we have automation that copies over the files from Elasticsearch. Was this file fixed in the Elasticsearch repo too?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Was about to setup a new PR for that; but good to know that automation will take care of this! Should I remove this part to avoid potential conflicts?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also, just to be on the safe side, would automation also handle backports if needed?

Copy link
Member

@pquentin pquentin Nov 20, 2024

Choose a reason for hiding this comment

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

Yes, the automation handles backports, and your change won't cause a conflict. I do think it's good to have here.

Even if the content ends up being different in Elasticsearch itself, we'll have a PR to review with the updated content.

Copy link
Contributor

Following you can find the validation results for the API you have changed.

API Status Request Response
open_point_in_time 🟢 7/7 7/7

You can validate this API yourself by using the make validate target.

@pquentin pquentin merged commit db4203b into main Nov 20, 2024
7 checks passed
@pquentin pquentin deleted the add_allow_partial_search_results_in_pit branch November 20, 2024 10:29
github-actions bot pushed a commit that referenced this pull request Nov 20, 2024
github-actions bot pushed a commit that referenced this pull request Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing allow_partial_search_results type in openPointInTime API
2 participants