Skip to content

Conversation

@charlotte-hoblik
Copy link
Contributor

@charlotte-hoblik charlotte-hoblik commented Sep 8, 2025

This PR updates the anlyze index disk usage API specification:

  • updates the response example so it appears/renders on the website
  • removes typos
  • adds link to the elasticsearch repository:
    • to add further explanation on the response example
    • the @ext_doc_id indices-disk-usage is already in use, just adds it to the page

Connected to elastic/docs-content#1247
DO NOT MERGE BEFORE: elastic/elasticsearch#134282

@github-actions
Copy link
Contributor

github-actions bot commented Sep 8, 2025

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.

I don't think wait_for_active_shards is actually supported:

Screenshot 2025-09-08 at 11 25 32

It's not in the code either, be it for main or 8.18.

@charlotte-hoblik
Copy link
Contributor Author

Preview of the page:
Screenshot 2025-09-09 at 9 53 45

Thank you @pquentin I removed the wait_for_active_shards

Copy link

@philippkahr philippkahr left a comment

Choose a reason for hiding this comment

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

LGTM,

We still cannot do explanations with the <1> and so in the json response right in the new docs?

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 when the reference docs are online.

@charlotte-hoblik
Copy link
Contributor Author

Thank you, Quentin and Philipp.
@philippkahr No, we still don’t have that option at the moment. Our approach for adding further explanations to examples, where necessary, is to dedicate a separate page for them in the reference section of the documentation. This PR covers that. Could you please take a look at it as well?

@charlotte-hoblik charlotte-hoblik merged commit a4676aa into main Sep 11, 2025
8 checks passed
@charlotte-hoblik charlotte-hoblik deleted the charlotte-disk-usage-api-1247 branch September 11, 2025 14:41
@github-actions
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-5264-to-9.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a4676aabf1b13839ec5bef82f775aad25dbdec22
# Push it to GitHub
git push --set-upstream origin backport-5264-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-5264-to-9.0.

@github-actions
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-5264-to-9.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a4676aabf1b13839ec5bef82f775aad25dbdec22
# Push it to GitHub
git push --set-upstream origin backport-5264-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-5264-to-9.1.

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.

4 participants