Skip to content

Add link to _update_by_query API examples #4705

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 7 commits into from
Jul 3, 2025

Conversation

charlotte-hoblik
Copy link
Contributor

@charlotte-hoblik charlotte-hoblik commented Jun 28, 2025

  • This PR adds a link for the _update_by_query API examples to the Elasticsearch reference documentation, as part of the approach to unify API reference documentation.
  • Adds 3 paragraphs to the API description as this information seemingly was missing from the API docs Requires confirmation!

Link to 8.18 documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.18/docs-update-by-query.html

DO NOT MERGE BEFORE elastic/elasticsearch#130273

Connected to:

https://github.com/elastic/docs-projects/issues/302
elastic/elasticsearch#130273

@charlotte-hoblik charlotte-hoblik marked this pull request as ready for review July 2, 2025 08:16
@leemthompo
Copy link
Contributor

leemthompo commented Jul 2, 2025

Adds 3 paragraphs to the API description as this information seemingly was missing from the API docs Requires confirmation!

  • a link to old docs would be helpful to confirm
  • it would also be nice to see a screenshot of the previewed description update to ensure formatting is as expected :)

@charlotte-hoblik
Copy link
Contributor Author

Thank you @leemthompo
I've added the link to the old docs to the description as well: https://www.elastic.co/guide/en/elasticsearch/reference/8.18/docs-update-by-query.html

Screenshot of the updated description:
Screenshot 2025-07-02 at 12 01 53

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

LGTM

@charlotte-hoblik charlotte-hoblik merged commit 30931cb into main Jul 3, 2025
8 checks passed
@charlotte-hoblik charlotte-hoblik deleted the charlotte-update-by-query-api branch July 3, 2025 11:07
Copy link
Contributor

github-actions bot commented Jul 3, 2025

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-4705-to-9.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 30931cbfa17b7c3bfafdeafbe6deb00a7bdb704e
# Push it to GitHub
git push --set-upstream origin backport-4705-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-4705-to-9.0.

github-actions bot pushed a commit that referenced this pull request Jul 3, 2025
* Add link and missing content to update by query

* Update specification/_global/update_by_query/UpdateByQueryRequest.ts

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 30931cb)
charlotte-hoblik added a commit that referenced this pull request Jul 3, 2025
* Add link and missing content to update by query

* Update specification/_global/update_by_query/UpdateByQueryRequest.ts

Co-authored-by: Liam Thompson <[email protected]>
pquentin pushed a commit that referenced this pull request Jul 4, 2025
* Add link and missing content to update by query

* Update specification/_global/update_by_query/UpdateByQueryRequest.ts


(cherry picked from commit 30931cb)

Co-authored-by: Charlotte Hoblik <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
pquentin pushed a commit that referenced this pull request Jul 4, 2025
* Add link and missing content to update by query

* Update specification/_global/update_by_query/UpdateByQueryRequest.ts

Co-authored-by: Liam Thompson <[email protected]>
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