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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

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

@@ -103,28 +127,14 @@ import { Duration } from '@_types/Time'
* * Update performance scales linearly across available resources with the number of slices.
*
* Whether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources.
*
Copy link
Contributor

Choose a reason for hiding this comment

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

How come we're losing this section?

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