Skip to content

Add missing indices options to index recovery API #4954

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
Jul 18, 2025

Conversation

ywangd
Copy link
Member

@ywangd ywangd commented Jul 18, 2025

The JSON API spec change on the ES side is
elastic/elasticsearch#131490

Raised this PR following the contribution guide. Please let me know if I have done things correctly. I assume this spec is what backs the associated doc page?These options are always supported but never documented. I am backporting the ES side PR all the way back to v8.18. Not sure if similar backporting is needed here.

@ywangd ywangd requested a review from pquentin July 18, 2025 00:40
Copy link
Contributor

Following you can find the validation changes against the target branch for the APIs.

No changes detected.

You can validate these APIs yourself by using the make validate target.

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.

Thanks! LGTM.

The JSON API spec change on the ES side is
elastic/elasticsearch#131490

Perfect, our automation picked this up in #4958, which I merged. This fixes the validation errors that you were seeing.

Raised this PR following the contribution guide. Please let me know if I have done things correctly.

This was perfect, thank you. Not everyone is as diligent. :)

I assume this spec is what backs the associated doc page?

Correct!

These options are always supported but never documented. I am backporting the ES side PR all the way back to v8.18. Not sure if similar backporting is needed here.

Yes, I applied the corresponding backport labels and will take care of the backports.

@pquentin pquentin merged commit 96e5f2e into main Jul 18, 2025
8 checks passed
@pquentin pquentin deleted the indices-options-for-index-recovery-api branch July 18, 2025 07:44
Copy link
Contributor

The backport to 8.19 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.19 8.19
# Navigate to the new working tree
cd .worktrees/backport-8.19
# Create a new branch
git switch --create backport-4954-to-8.19
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 96e5f2e8047ac670e988d68c10f9faa2a7a6cb93
# Push it to GitHub
git push --set-upstream origin backport-4954-to-8.19
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.19

Then, create a pull request where the base branch is 8.19 and the compare/head branch is backport-4954-to-8.19.

Copy link
Contributor

The backport to 8.18 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.18 8.18
# Navigate to the new working tree
cd .worktrees/backport-8.18
# Create a new branch
git switch --create backport-4954-to-8.18
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 96e5f2e8047ac670e988d68c10f9faa2a7a6cb93
# Push it to GitHub
git push --set-upstream origin backport-4954-to-8.18
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.18

Then, create a pull request where the base branch is 8.18 and the compare/head branch is backport-4954-to-8.18.

Copy link
Contributor

The backport to 9.0 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.0 9.0
# Navigate to the new working tree
cd .worktrees/backport-9.0
# Create a new branch
git switch --create backport-4954-to-9.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 96e5f2e8047ac670e988d68c10f9faa2a7a6cb93
# Push it to GitHub
git push --set-upstream origin backport-4954-to-9.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.0

Then, create a pull request where the base branch is 9.0 and the compare/head branch is backport-4954-to-9.0.

Copy link
Contributor

The backport to 9.1 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.1 9.1
# Navigate to the new working tree
cd .worktrees/backport-9.1
# Create a new branch
git switch --create backport-4954-to-9.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 96e5f2e8047ac670e988d68c10f9faa2a7a6cb93
# Push it to GitHub
git push --set-upstream origin backport-4954-to-9.1
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.1

Then, create a pull request where the base branch is 9.1 and the compare/head branch is backport-4954-to-9.1.

pquentin pushed a commit that referenced this pull request Jul 18, 2025
The JSON API spec change on the ES side is
elastic/elasticsearch#131490

Co-authored-by: Quentin Pradet <[email protected]>
(cherry picked from commit 96e5f2e)

# Conflicts:
#	output/schema/validation-errors.json
pquentin pushed a commit that referenced this pull request Jul 18, 2025
The JSON API spec change on the ES side is
elastic/elasticsearch#131490

Co-authored-by: Quentin Pradet <[email protected]>
(cherry picked from commit 96e5f2e)

# Conflicts:
#	output/schema/validation-errors.json
pquentin pushed a commit that referenced this pull request Jul 18, 2025
The JSON API spec change on the ES side is
elastic/elasticsearch#131490

Co-authored-by: Quentin Pradet <[email protected]>
(cherry picked from commit 96e5f2e)

# Conflicts:
#	output/schema/validation-errors.json
pquentin pushed a commit that referenced this pull request Jul 18, 2025
The JSON API spec change on the ES side is
elastic/elasticsearch#131490

Co-authored-by: Quentin Pradet <[email protected]>
(cherry picked from commit 96e5f2e)

# Conflicts:
#	output/schema/validation-errors.json
@pquentin
Copy link
Member

💚 All backports created successfully

Status Branch Result
9.1
9.0
8.19
8.18

Questions ?

Please refer to the Backport tool documentation

pquentin added a commit that referenced this pull request Jul 18, 2025
The JSON API spec change on the ES side is
elastic/elasticsearch#131490

Co-authored-by: Quentin Pradet <[email protected]>
(cherry picked from commit 96e5f2e)

# Conflicts:
#	output/schema/validation-errors.json

Co-authored-by: Yang Wang <[email protected]>
pquentin added a commit that referenced this pull request Jul 18, 2025
The JSON API spec change on the ES side is
elastic/elasticsearch#131490

Co-authored-by: Quentin Pradet <[email protected]>
(cherry picked from commit 96e5f2e)

# Conflicts:
#	output/schema/validation-errors.json

Co-authored-by: Yang Wang <[email protected]>
pquentin added a commit that referenced this pull request Jul 18, 2025
The JSON API spec change on the ES side is
elastic/elasticsearch#131490

Co-authored-by: Quentin Pradet <[email protected]>
(cherry picked from commit 96e5f2e)

# Conflicts:
#	output/schema/validation-errors.json

Co-authored-by: Yang Wang <[email protected]>
pquentin added a commit that referenced this pull request Jul 18, 2025
The JSON API spec change on the ES side is
elastic/elasticsearch#131490

Co-authored-by: Quentin Pradet <[email protected]>
(cherry picked from commit 96e5f2e)

# Conflicts:
#	output/schema/validation-errors.json

Co-authored-by: Yang Wang <[email protected]>
@ywangd
Copy link
Member Author

ywangd commented Jul 21, 2025

Thanks for taking care of merging and backporting the PR! 👍

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.

2 participants