Skip to content

Fix order of request body search parameter names #40777

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

Merged
merged 1 commit into from
Apr 9, 2019
Merged

Fix order of request body search parameter names #40777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 22 additions & 20 deletions docs/reference/search/request-body.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,46 +188,48 @@ to the client. This means it includes the time spent waiting in thread pools,
executing a distributed search across the whole cluster and gathering all the
results.

include::request/query.asciidoc[]
Copy link
Contributor

@jrodewig jrodewig Apr 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the PR! I agree that these parameters need a reorganization.

Not blocking, but I wonder if there is some value in leaving basic or commonly used parameters, like query or sort near the top.

It seems like a pertinent question is "how are users currently accessing these parameter pages?" I don't currently have access to Google Analytics or web analytics data (working on it), but that might give us an indicator.

That said, I'm good with proceeding if others are.

include::request/docvalue-fields.asciidoc[]

include::request/from-size.asciidoc[]
include::request/explain.asciidoc[]

include::request/sort.asciidoc[]
include::request/collapse.asciidoc[]

include::request/track-total-hits.asciidoc[]
include::request/from-size.asciidoc[]

include::request/source-filtering.asciidoc[]
include::request/highlighting.asciidoc[]

include::request/stored-fields.asciidoc[]
include::request/index-boost.asciidoc[]

include::request/script-fields.asciidoc[]
include::request/inner-hits.asciidoc[]

include::request/docvalue-fields.asciidoc[]
include::request/min-score.asciidoc[]

include::request/named-queries-and-filters.asciidoc[]

include::request/post-filter.asciidoc[]

include::request/highlighting.asciidoc[]
include::request/preference.asciidoc[]

include::request/query.asciidoc[]

include::request/rescore.asciidoc[]

include::request/search-type.asciidoc[]
include::request/script-fields.asciidoc[]

include::request/scroll.asciidoc[]

include::request/preference.asciidoc[]

include::request/explain.asciidoc[]
include::request/search-after.asciidoc[]

include::request/version-and-seq-no.asciidoc[]
include::request/search-type.asciidoc[]

include::request/index-boost.asciidoc[]
include::request/seq-no.asciidoc[]

include::request/min-score.asciidoc[]
include::request/sort.asciidoc[]

include::request/named-queries-and-filters.asciidoc[]
include::request/source-filtering.asciidoc[]

include::request/inner-hits.asciidoc[]
include::request/stored-fields.asciidoc[]

include::request/collapse.asciidoc[]
include::request/track-total-hits.asciidoc[]

include::request/search-after.asciidoc[]
include::request/version.asciidoc[]
17 changes: 0 additions & 17 deletions ...earch/request/version-and-seq-no.asciidoc → .../reference/search/request/seq-no.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,3 @@ GET /_search
}
--------------------------------------------------
// CONSOLE

[[search-request-version]]
=== Version

Returns a version for each search hit.

[source,js]
--------------------------------------------------
GET /_search
{
"version": true,
"query" : {
"term" : { "user" : "kimchy" }
}
}
--------------------------------------------------
// CONSOLE
2 changes: 1 addition & 1 deletion docs/reference/search/request/stored-fields.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[search-request-stored-fields]]
=== Fields
=== Stored Fields

WARNING: The `stored_fields` parameter is about fields that are explicitly marked as
stored in the mapping, which is off by default and generally not recommended.
Expand Down
16 changes: 16 additions & 0 deletions docs/reference/search/request/version.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[[search-request-version]]
=== Version

Returns a version for each search hit.

[source,js]
--------------------------------------------------
GET /_search
{
"version": true,
"query" : {
"term" : { "user" : "kimchy" }
}
}
--------------------------------------------------
// CONSOLE