Skip to content

[DOCS] Reformats simple query string query#45343

Merged
jrodewig merged 4 commits intomasterfrom
simple-query-string
Aug 9, 2019
Merged

[DOCS] Reformats simple query string query#45343
jrodewig merged 4 commits intomasterfrom
simple-query-string

Conversation

@jrodewig
Copy link
Copy Markdown
Contributor

@jrodewig jrodewig commented Aug 8, 2019

Updates the simple_query_string query to use the new query format.

This creates separate sections for the example request, parameters, and notes.

This is part of #40977, an effort to standardize documentation for query types.

Preview

http://elasticsearch_45343.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/query-dsl-simple-query-string-query.html

@jrodewig jrodewig added >docs General docs changes :Search/Search Search-related issues that do not fall into other categories v8.0.0 v7.0.2 v7.1.2 v7.4.0 v7.3.1 v7.2.2 labels Aug 8, 2019
@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-search

@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-docs

@mayya-sharipova mayya-sharipova self-requested a review August 8, 2019 20:17
regular `query_string` query, the `simple_query_string` query will never
throw an exception, and discards invalid parts of the query. Here is
an example:
Returns documents based on a provided query string, using a limited but
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it is good to mention parser/parsing in the definition, something like this:

Returns documents based on parsing a provided query string, using a parser with limited but ...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Re-added with 4bcb328.

@mayya-sharipova
Copy link
Copy Markdown
Contributor

@jrodewig Thanks, nice reorganization. I have left a couple of small comments

@jrodewig jrodewig merged commit bf0ac30 into master Aug 9, 2019
@jrodewig jrodewig deleted the simple-query-string branch August 9, 2019 12:32
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 v7.0.2 v7.1.2 v7.2.2 v7.3.1 v7.4.0 v8.0.0-alpha1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants