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

[DOCS] Add response body parms to search API docs #47042

Merged
merged 12 commits into from
Sep 30, 2019
Merged

[DOCS] Add response body parms to search API docs #47042

merged 12 commits into from
Sep 30, 2019

Conversation

jrodewig
Copy link
Contributor

Changes

  • Fixes incorrect request syntax
  • Documents response body parameters for the _search API.
  • Adds headings and additional examples to 'Examples' section.

@jrodewig jrodewig added >docs General docs changes :Search/Search Search-related issues that do not fall into other categories v8.0.0 v7.3.0 v7.4.0 v7.5.0 labels Sep 24, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search

jrodewig
jrodewig commented Sep 24, 2019
View reviewed changes
docs/reference/search/search.asciidoc
@@ -4,18 +4,22 @@
Returns search hits that match the query defined in the request.

[source,console]
--------------------------------------------------
GET /twitter/_search?q=user:kimchy
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This example has been moved here:
https://github.com/elastic/elasticsearch/pull/47042/files#diff-bcfac6633e675424434326d14790f815R326

@jrodewig jrodewig added v7.4.1 and removed v7.4.0 labels Sep 27, 2019
@jrodewig jrodewig requested review from jpountz and imotov September 27, 2019 17:33
@jrodewig
Copy link
Contributor Author

Preview link: http://elasticsearch_47042.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/search-search.html

@jrodewig
Copy link
Contributor Author

@imotov My took time description was based on your response here:
https://discuss.elastic.co/t/query-timing-took-value-and-what-im-measuring/9870/2

jpountz
jpountz reviewed Sep 30, 2019
View reviewed changes
Copy link
Contributor

@jpountz jpountz left a comment

Choose a reason for hiding this comment

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

Thanks @jrodewig these clarifications will certainly help our users. I left a couple suggestions to clarify even more based on questions I have seen in the past.

docs/reference/search/search.asciidoc Show resolved Hide resolved
docs/reference/search/search.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search.asciidoc Show resolved Hide resolved
docs/reference/search/search.asciidoc Show resolved Hide resolved
jpountz
jpountz approved these changes Sep 30, 2019
View reviewed changes
docs/reference/search/search.asciidoc Outdated Show resolved Hide resolved
@jrodewig jrodewig requested a review from imotov September 30, 2019 13:10
@jrodewig
Copy link
Contributor Author

Thanks for your feedback @imotov and @jpountz!

@jrodewig jrodewig merged commit 2fd0514 into elastic:master Sep 30, 2019
@jrodewig jrodewig deleted the document-search-response-body branch September 30, 2019 15:41
This was referenced Sep 30, 2019
Merged
Merged
Merged
jrodewig added a commit that referenced this pull request Sep 30, 2019
@jrodewig
[7.x] [DOCS] Add response body parms to search API docs (#47042) (#47303
fd421bd 
)
jrodewig added a commit that referenced this pull request Sep 30, 2019
@jrodewig
[7.4] [DOCS] Add response body parms to search API docs (#47042) (#47304
aa99676 
)
jrodewig added a commit that referenced this pull request Sep 30, 2019
@jrodewig
[7.3] [DOCS] Add response body parms to search API docs (#47042) (#47307
0a04365 
)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@imotov imotov imotov approved these changes

@jpountz jpountz jpountz approved these changes

Assignees
No one assigned
Labels
>docs General docs changes :Search/Search Search-related issues that do not fall into other categories v7.3.0 v7.4.1 v7.5.0 v8.0.0-alpha1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jrodewig @elasticmachine @jpountz @imotov @jakelandis