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.

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

Search docs page is not comprehensive #92208

Open
javanna opened this issue Dec 7, 2022 · 3 comments
Open

Search docs page is not comprehensive #92208

javanna opened this issue Dec 7, 2022 · 3 comments
Labels
>docs General docs changes :Search/Search Search-related issues that do not fall into other categories Team:Docs Meta label for docs team Team:Search Meta label for search team

Comments

@javanna
Copy link
Member

javanna commented Dec 7, 2022

I noticed that the search docs page at https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html lists the elements that a search response can be made of, but the list is incomplete, for instance aggregations and fields are missing. I believe that rescore and sort are also missing in the request section. Maybe worth checking if anything else is missing.

@javanna javanna added >docs General docs changes :Search/Search Search-related issues that do not fall into other categories labels Dec 7, 2022
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:Search Meta label for search team labels Dec 7, 2022
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-search (Team:Search)

@abdonpijpelink
Copy link
Contributor

abdonpijpelink commented Jul 6, 2023

Other missing parameters from the _search API reference page:

  • min_compatible_shard_node (query parameter)
  • collapse (body)
  • highlight (body)
  • post_filter (body)
  • search_after (body)
  • suggest (body)
  • slice (body)
  • sort (body)

This effort is probably not that relevant any more, as we're moving to generating the API reference docs from the spec (which does have all the parameters).

@abdonpijpelink abdonpijpelink removed their assignment Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :Search/Search Search-related issues that do not fall into other categories Team:Docs Meta label for docs team Team:Search Meta label for search team
Projects
None yet
Development

No branches or pull requests

3 participants