Skip to content

[DOCS] Add link to stored fields example #4576

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 3 commits into
base: main
Choose a base branch
from

Conversation

marciw
Copy link
Contributor

@marciw marciw commented Jun 13, 2025

Related to elastic/docs-projects#302 and elastic/elasticsearch#129380

DO NOT MERGE BEFORE elastic/elasticsearch#129380

  • Add example link to stored_fields parameter description
  • Fix unrelated typos

Copy link
Contributor

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

API Status Request Response
get 🟢 299/299 296/296

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

Copy link
Contributor

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

API Status Request Response
get 🟢 299/299 296/296

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

Copy link
Contributor

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

API Status Request Response
get 🟢 299/299 296/296

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

@marciw marciw changed the title WIP [DOCS] Add link to stored fields example [DOCS] Add link to stored fields example Jun 16, 2025
@marciw marciw marked this pull request as ready for review June 16, 2025 14:45
@marciw marciw requested review from szabosteve and leemthompo June 16, 2025 14:45
Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

I left one suggestion.

* Object fields can't be returned;​if specified, the request fails.
* Only leaf fields can be retrieved with the `stored_fields` option.
* Object fields can't be returned; if specified, the request fails.
* For an example, refer to [Retrieve stored fields](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-stored-fields).
Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry, I didn't mention it earlier, we can use ext_doc_id here. Please add the next line to the table.csv file as part of this PR, so we can keep track the links we are adding:
retrieve-stored-fields,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-stored-fields
and then refer to the ID as the suggestions shows below, please.

Suggested change
* For an example, refer to [Retrieve stored fields](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-stored-fields).
* @ext_doc_id retrieve-stored-fields

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't think this was a good case for ext_doc_id because it's a section-specific thing that's not likely to be reused. Or is it required?

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