Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Get API has wrong description for stored_fields parameter #98385

Closed
sabi0 opened this issue Aug 11, 2023 · 3 comments · Fixed by #108445
Closed

Get API has wrong description for stored_fields parameter #98385

sabi0 opened this issue Aug 11, 2023 · 3 comments · Fixed by #108445
Labels
:Distributed/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. >docs General docs changes Team:Distributed Meta label for distributed team Team:Docs Meta label for docs team

Comments

@sabi0
Copy link
Contributor

sabi0 commented Aug 11, 2023 •
edited

Both 7.17 and 8.9 (current) "Get API" page describe the stored_fields parameter as

stored_fields
(Optional, Boolean) If true, retrieves the document fields stored in the index rather than the document _source. Defaults to false.

But in fact it accepts a comma-separated list of stored fields to retrieve, as described in the "Get stored fields" section at the bottom of the page:

Use the stored_fields parameter to specify the set of stored fields you want to retrieve.
...
GET my-index-000001/_doc/1?stored_fields=tags,counter
@abdonpijpelink abdonpijpelink transferred this issue from elastic/docs Aug 11, 2023
@elasticsearchmachine elasticsearchmachine added the needs:triage Requires assignment of a team area label label Aug 11, 2023
@abdonpijpelink abdonpijpelink added >docs General docs changes :Distributed/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. and removed needs:triage Requires assignment of a team area label labels Aug 11, 2023
@elasticsearchmachine elasticsearchmachine added Team:Distributed Meta label for distributed team Team:Docs Meta label for docs team labels Aug 11, 2023
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

@abdonpijpelink
Copy link
Contributor

Thanks for reporting this @sabi0 . I've transferred your issue to the elasticsearch repo.

I think you're right, looking at the API spec: stored_fields accepts a list of fields, instead of a boolean value. I'll let someone from @elastic/es-distributed confirm.

nicktindall added a commit to nicktindall/elasticsearch that referenced this issue May 9, 2024
@nicktindall
[DOCS] Fix stored_fields parameter description (elastic#98385)
8b0a1f0 
(referenced from get and multi_get API docs)

Closes elastic#98385
@nicktindall nicktindall mentioned this issue May 9, 2024
Merged
nicktindall added a commit to nicktindall/elasticsearch that referenced this issue May 9, 2024
@nicktindall
[DOCS] Fix stored_fields parameter description (elastic#98385)
a80dc76 
(referenced from get and multi_get API docs)

Closes elastic#98385
nicktindall added a commit to nicktindall/elasticsearch that referenced this issue May 9, 2024
@nicktindall
[DOCS] Fix stored_fields parameter description (elastic#98385)
f9800c9 
(referenced from get and multi_get API docs)

Closes elastic#98385
elasticsearchmachine pushed a commit that referenced this issue May 9, 2024
@nicktindall
[DOCS] Fix stored_fields parameter description (#98385) (#108445)
68a8664 
(referenced from get and multi_get API docs)

Closes #98385
@nicktindall nicktindall mentioned this issue May 9, 2024
Merged
nicktindall added a commit to nicktindall/elasticsearch that referenced this issue May 9, 2024
@nicktindall
[DOCS] Fix stored_fields parameter description (elastic#98385) (elast…
8487dc7 
…ic#108445)

(referenced from get and multi_get API docs)

Closes elastic#98385
@nicktindall nicktindall mentioned this issue May 9, 2024
Merged
elasticsearchmachine pushed a commit that referenced this issue May 9, 2024
@nicktindall
[DOCS] Fix stored_fields parameter description (#98385) (#108445) (#1…
f6ac110 
…08446)

(referenced from get and multi_get API docs)

Closes #98385
elasticsearchmachine pushed a commit that referenced this issue May 9, 2024
@nicktindall
[DOCS] Fix stored_fields parameter description (#98385) (#108445) (#1…
2a327b1 
…08447)

(referenced from get and multi_get API docs)

Closes #98385
markjhoy pushed a commit to markjhoy/elasticsearch that referenced this issue May 9, 2024
@nicktindall @markjhoy
[DOCS] Fix stored_fields parameter description (elastic#98385) (elast…
be4615e 
…ic#108445)

(referenced from get and multi_get API docs)

Closes elastic#98385
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
:Distributed/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. >docs General docs changes Team:Distributed Meta label for distributed team Team:Docs Meta label for docs team
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DOCS] Fix stored_fields parameter description nicktindall/elasticsearch
3 participants
@abdonpijpelink @sabi0 @elasticsearchmachine