From e526139d22de3ed92f2cf21460741f93b77be177 Mon Sep 17 00:00:00 2001 From: Liza K Date: Tue, 29 Sep 2020 13:48:51 +0300 Subject: [PATCH 01/21] data readme --- src/plugins/data/README.md | 140 +++++++++++++++++++++++++++++++++++-- 1 file changed, 134 insertions(+), 6 deletions(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index da0b71122fd9e..fe26b04f9f5e7 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -1,9 +1,137 @@ # data -`data` plugin provides common data access services. +The `data` plugin provides common services for solutions and application developers. -- `expressions` — run pipeline functions and render results. -- `filter` -- `index_patterns` -- `query` -- `search`: Elasticsearch API service and strategies \ No newline at end of file +## Autocomplete + +The autocomplete service can provide suggestions for field names and field values. + +It is pre-wired into the `TopNavMenu` component, but can be used independently. + +### Fetch Query Suggestions + +The `getQuerySuggestions` helps to construct a query. +KQL suggestion functions are registered in x-pack, so this API won't return results in OSS. + +```.ts + + // `inputValue` is the user input + const querySuggestions = await autocomplete.getQuerySuggestions({ + language: 'kuery', + indexPatterns: [indexPattern], + query: inputValue, + }); + +``` + +### Fetch Value Suggestions + +The `getValueSuggestions` returns suggestions for possible field values. +This is helpful when you want to provide a user with options to choose from, for example when constructing a filter. + +```.ts + + // `inputValue` is the user input + const valueSuggestions = await autocomplete.getValueSuggestions({ + indexPattern, + field, + query: inputValue, + }); + +``` + +## Field Formats + +Coming soon. + +## Index Patterns + +Coming soon. + +## Query + +The query service is responsible for managing the configuration of a search query (`QueryState`): filters, timerange and query string, as well as other settings such as the auto refresh behavior and saved queries. + +It contains sub-services for each of those configurations: + - `data.query.filterManager` - Manages the `filters` component of a `QueryState`. The global filter state (filters that are persisted between applications) are owned by this service. + - `data.query.timefilter` - Responsible for the time range filter as well as the auto refresh behavior settings. + - `data.query.queryString` - Responsible for the query string and query language settings. + - `data.query.savedQueries` - This sub-service is responsible for persisting a `QueryState` into a `SavedObject`, so it can be restored and re-used by other applications. + + Any changes to the `QueryState` are published on the `data.query.state$`, which is useful when wanting to persist global state or run a search upon data changes. + + A simple use case would be: + + ```.ts + function searchOnChange(indexPattern: IndexPattern, aggConfigs: AggConfigs) { + data.query.state$.subscribe(() => { + + // Constuct the query portion of the search request + const query = data.query.getEsQuery(indexPattern); + + // Construct a request + const request = { + params: { + index: indexPattern.title, + body: { + aggs: aggConfigs.toDsl(), + query, + }, + }, + }; + + // Search with the `data.query` config + const search$ = data.search.search(request); + + ... + }); + } + + ``` + +## Search + +Provides access to Elasticsearch using the high level `SearchSource` API or low level `Search Strategies`. + +### SearchSource + +The `SearchSource` API is a convenient way to construct and run an Elasticsearch search query + +```.tsx + + const searchSource = await data.search.searchSource.create(); + const searchResponse = await searchSource + .setParent(undefined) + .setField('index', indexPattern) + .setField('filter', filters) + .fetch(); + +``` + +### Low level search + +#### Default Search Strategy + +One benefit of using the low level search API, is partial response support in x-pack, allowing for better and more responsive user experience. +In OSS only the final result is returned. + +```.ts + import { isCompleteResponse } from '../plugins/data/public'; + + const search$ = data.search.search(request) + .subscribe({ + next: (response) => { + if (isCompleteResponse(response)) { + // Final result + search$.unsubscribe(); + } else { + // Partial result - you can update the UI, but data is still loading + } + }, + error: (e: Error) => { + // Show customized toast notifications. + // You may choose to handle errors differently if you prefer. + data.search.showError(e); + }, + }); +``` From 7e76977ba3b20f6d0aa7ce83bf7e24030437dfc0 Mon Sep 17 00:00:00 2001 From: Liza K Date: Tue, 29 Sep 2020 13:50:14 +0300 Subject: [PATCH 02/21] Delete old readme (other folders don't have a README of their own. --- src/plugins/data/public/search/README.md | 23 ----------------------- 1 file changed, 23 deletions(-) delete mode 100644 src/plugins/data/public/search/README.md diff --git a/src/plugins/data/public/search/README.md b/src/plugins/data/public/search/README.md deleted file mode 100644 index 0a123ffa3f1e9..0000000000000 --- a/src/plugins/data/public/search/README.md +++ /dev/null @@ -1,23 +0,0 @@ -# search - -The `search` service provides you with APIs to query Elasticsearch. - -The services are split into two parts: (1) low-level API; and (2) high-level API. - -## Low-level API - -With low level API you work directly with elasticsearch DSL - -```typescript -const results = await data.search.search(request, params); -``` - -## High-level API - -Using high-level API you work with Kibana abstractions around Elasticsearch DSL: filters, queries, and aggregations. Provided by the *Search Source* service. - -```typescript -const search = data.search.searchSource.createEmpty(); -search.setField('query', data.query.queryString); -const results = await search.fetch(); -``` From e3a9b47fcca4607d7b437ec100722417f713d7fd Mon Sep 17 00:00:00 2001 From: Liza K Date: Tue, 29 Sep 2020 16:03:22 +0300 Subject: [PATCH 03/21] generate asciidoc --- docs/developer/plugin-list.asciidoc | 2 +- src/plugins/data/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index 5a4a60c2e628e..b59613ec6a648 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -48,7 +48,7 @@ NOTE: |{kib-repo}blob/{branch}/src/plugins/data/README.md[data] -|data plugin provides common data access services. +|The data plugin provides common data access services for solutions and application developers. |{kib-repo}blob/{branch}/src/plugins/dev_tools/README.md[devTools] diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index fe26b04f9f5e7..e0a77b7146ada 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -1,6 +1,6 @@ # data -The `data` plugin provides common services for solutions and application developers. +The `data` plugin provides common data access services for solutions and application developers. ## Autocomplete From 0d6eef0a759838a44e7385b90deeb636c4b0e2f2 Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 21:43:13 +0300 Subject: [PATCH 04/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index e0a77b7146ada..f1f43392dd591 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -4,7 +4,7 @@ The `data` plugin provides common data access services for solutions and applica ## Autocomplete -The autocomplete service can provide suggestions for field names and field values. +The autocomplete service provides suggestions for field names and values. It is pre-wired into the `TopNavMenu` component, but can be used independently. From 0e5e2999072052e186293d69b194bd7f675cb668 Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 21:43:30 +0300 Subject: [PATCH 05/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index f1f43392dd591..3643f495464e1 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -6,7 +6,7 @@ The `data` plugin provides common data access services for solutions and applica The autocomplete service provides suggestions for field names and values. -It is pre-wired into the `TopNavMenu` component, but can be used independently. +It is wired into the `TopNavMenu` component, but can be used independently. ### Fetch Query Suggestions From 79e64b710447618fc2b3db5e9981ed100b70f4c6 Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 21:43:41 +0300 Subject: [PATCH 06/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index 3643f495464e1..e20bd978841db 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -11,7 +11,7 @@ It is wired into the `TopNavMenu` component, but can be used independently. ### Fetch Query Suggestions The `getQuerySuggestions` helps to construct a query. -KQL suggestion functions are registered in x-pack, so this API won't return results in OSS. +KQL suggestion functions are registered in X-Pack, so this API does not return results in OSS. ```.ts From 6c23345ca2a00c301eee17436eb9ea7f4f42d68a Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 21:46:19 +0300 Subject: [PATCH 07/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index e20bd978841db..7bf62e2a46bc4 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -56,7 +56,7 @@ It contains sub-services for each of those configurations: - `data.query.filterManager` - Manages the `filters` component of a `QueryState`. The global filter state (filters that are persisted between applications) are owned by this service. - `data.query.timefilter` - Responsible for the time range filter as well as the auto refresh behavior settings. - `data.query.queryString` - Responsible for the query string and query language settings. - - `data.query.savedQueries` - This sub-service is responsible for persisting a `QueryState` into a `SavedObject`, so it can be restored and re-used by other applications. + - `data.query.savedQueries` - This sub-service is responsible for persisting a `QueryState` into a `SavedObject`, so it can be restored and used by other applications. Any changes to the `QueryState` are published on the `data.query.state$`, which is useful when wanting to persist global state or run a search upon data changes. From f872f4e8f9c24b6e0b8945578e4fb5bb970c6b05 Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 21:46:30 +0300 Subject: [PATCH 08/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index 7bf62e2a46bc4..789a198fea447 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -60,7 +60,7 @@ It contains sub-services for each of those configurations: Any changes to the `QueryState` are published on the `data.query.state$`, which is useful when wanting to persist global state or run a search upon data changes. - A simple use case would be: + A simple use case is: ```.ts function searchOnChange(indexPattern: IndexPattern, aggConfigs: AggConfigs) { From 9c67a219697641e90fa0e4657f0ff1129f1f6a60 Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 21:46:44 +0300 Subject: [PATCH 09/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index 789a198fea447..48ca2ad540c85 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -112,7 +112,7 @@ The `SearchSource` API is a convenient way to construct and run an Elasticsearch #### Default Search Strategy -One benefit of using the low level search API, is partial response support in x-pack, allowing for better and more responsive user experience. +One benefit of using the low level search API, is partial response support in X-Pack, allowing for a better and more responsive user experience. In OSS only the final result is returned. ```.ts From f5bbdb6ad398dcf90465321fd7dbf57dab7e08bc Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 21:47:03 +0300 Subject: [PATCH 10/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index 48ca2ad540c85..b603a0929cffd 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -95,7 +95,7 @@ Provides access to Elasticsearch using the high level `SearchSource` API or low ### SearchSource -The `SearchSource` API is a convenient way to construct and run an Elasticsearch search query +The `SearchSource` API is a convenient way to construct and run an Elasticsearch search query. ```.tsx From ab3a3a1a7c794161cb6a751ffafefaf277942167 Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 21:47:57 +0300 Subject: [PATCH 11/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index b603a0929cffd..8df7f7c3a4cbb 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -10,7 +10,7 @@ It is wired into the `TopNavMenu` component, but can be used independently. ### Fetch Query Suggestions -The `getQuerySuggestions` helps to construct a query. +The `getQuerySuggestions` function helps to construct a query. KQL suggestion functions are registered in X-Pack, so this API does not return results in OSS. ```.ts From 51dbf513e9669a18fc60a658f6bf2972ed4ed0ba Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 21:48:17 +0300 Subject: [PATCH 12/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index 8df7f7c3a4cbb..a4b198fbb784f 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -26,7 +26,7 @@ KQL suggestion functions are registered in X-Pack, so this API does not return r ### Fetch Value Suggestions -The `getValueSuggestions` returns suggestions for possible field values. +The `getValueSuggestions` function returns suggestions for field values. This is helpful when you want to provide a user with options to choose from, for example when constructing a filter. ```.ts From abcf85d3c6aa3cf5df5f42e47708d4234583c121 Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 21:49:22 +0300 Subject: [PATCH 13/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index a4b198fbb784f..169ef9eebaa81 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -27,7 +27,7 @@ KQL suggestion functions are registered in X-Pack, so this API does not return r ### Fetch Value Suggestions The `getValueSuggestions` function returns suggestions for field values. -This is helpful when you want to provide a user with options to choose from, for example when constructing a filter. +This is helpful when you want to provide a user with options, for example when constructing a filter. ```.ts From 8cd1954ed2a205d194eef6a541c0e1a48ff4ebc0 Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 21:49:43 +0300 Subject: [PATCH 14/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index 169ef9eebaa81..6ffa46777fe6b 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -50,7 +50,7 @@ Coming soon. ## Query -The query service is responsible for managing the configuration of a search query (`QueryState`): filters, timerange and query string, as well as other settings such as the auto refresh behavior and saved queries. +The query service is responsible for managing the configuration of a search query (`QueryState`): filters, time range, query string, and settings such as the auto refresh behavior and saved queries. It contains sub-services for each of those configurations: - `data.query.filterManager` - Manages the `filters` component of a `QueryState`. The global filter state (filters that are persisted between applications) are owned by this service. From 07d22df9e28ebd3aa2bcba323bdd8fe9542ddc33 Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 21:50:02 +0300 Subject: [PATCH 15/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index 6ffa46777fe6b..9aaef7deb49d7 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -54,7 +54,7 @@ The query service is responsible for managing the configuration of a search quer It contains sub-services for each of those configurations: - `data.query.filterManager` - Manages the `filters` component of a `QueryState`. The global filter state (filters that are persisted between applications) are owned by this service. - - `data.query.timefilter` - Responsible for the time range filter as well as the auto refresh behavior settings. + - `data.query.timefilter` - Responsible for the time range filter and the auto refresh behavior settings. - `data.query.queryString` - Responsible for the query string and query language settings. - `data.query.savedQueries` - This sub-service is responsible for persisting a `QueryState` into a `SavedObject`, so it can be restored and used by other applications. From e69566c08a7d000693998ce717ad8415dbc77728 Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 22:17:01 +0300 Subject: [PATCH 16/21] Update README.md --- src/plugins/data/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index 9aaef7deb49d7..b61b2f1093cf8 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -1,6 +1,6 @@ # data -The `data` plugin provides common data access services for solutions and application developers. +The data plugin provides common data access services, such as `search` and `query`, for solutions and application developers. ## Autocomplete @@ -56,7 +56,7 @@ It contains sub-services for each of those configurations: - `data.query.filterManager` - Manages the `filters` component of a `QueryState`. The global filter state (filters that are persisted between applications) are owned by this service. - `data.query.timefilter` - Responsible for the time range filter and the auto refresh behavior settings. - `data.query.queryString` - Responsible for the query string and query language settings. - - `data.query.savedQueries` - This sub-service is responsible for persisting a `QueryState` into a `SavedObject`, so it can be restored and used by other applications. + - `data.query.savedQueries` - Responsible for persisting a `QueryState` into a `SavedObject`, so it can be restored and used by other applications. Any changes to the `QueryState` are published on the `data.query.state$`, which is useful when wanting to persist global state or run a search upon data changes. From b5e17fec19f105fa95ff94790fcd360380246bce Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Tue, 29 Sep 2020 22:17:27 +0300 Subject: [PATCH 17/21] Update plugin-list.asciidoc --- docs/developer/plugin-list.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index b59613ec6a648..a1ab48e6519ab 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -48,7 +48,7 @@ NOTE: |{kib-repo}blob/{branch}/src/plugins/data/README.md[data] -|The data plugin provides common data access services for solutions and application developers. +|The data plugin provides common data access services, such as `search` and `query`, for solutions and application developers. |{kib-repo}blob/{branch}/src/plugins/dev_tools/README.md[devTools] From 129e229525496f6e478ad6dbe81bc5673c501855 Mon Sep 17 00:00:00 2001 From: Liza K Date: Wed, 30 Sep 2020 13:38:06 +0300 Subject: [PATCH 18/21] gen plugin list --- docs/developer/plugin-list.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index 10a00c814037e..3f087bf162d9a 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -48,7 +48,7 @@ NOTE: |{kib-repo}blob/{branch}/src/plugins/data/README.md[data] -|The data plugin provides common data access services, such as `search` and `query`, for solutions and application developers. +|The data plugin provides common data access services, such as search and query, for solutions and application developers. |{kib-repo}blob/{branch}/src/plugins/dev_tools/README.md[devTools] From 51d4c58d70302edc54573f312c8245a61d7e601d Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Wed, 30 Sep 2020 20:39:26 +0300 Subject: [PATCH 19/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index b61b2f1093cf8..900dba0345550 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -91,7 +91,7 @@ It contains sub-services for each of those configurations: ## Search -Provides access to Elasticsearch using the high level `SearchSource` API or low level `Search Strategies`. +Provides access to Elasticsearch using the high-level `SearchSource` API or low-level `Search Strategies`. ### SearchSource From fd2f5056f8152a84483750428e9b8e10e7df4e9a Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Wed, 30 Sep 2020 20:42:26 +0300 Subject: [PATCH 20/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index 900dba0345550..5511aaa7d011a 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -108,7 +108,7 @@ The `SearchSource` API is a convenient way to construct and run an Elasticsearch ``` -### Low level search +### Low-level search #### Default Search Strategy From 8481a6155610209841c8ee961a1d918b437be6de Mon Sep 17 00:00:00 2001 From: Liza Katz Date: Wed, 30 Sep 2020 20:44:17 +0300 Subject: [PATCH 21/21] Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- src/plugins/data/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plugins/data/README.md b/src/plugins/data/README.md index 5511aaa7d011a..33c07078c5348 100644 --- a/src/plugins/data/README.md +++ b/src/plugins/data/README.md @@ -112,7 +112,7 @@ The `SearchSource` API is a convenient way to construct and run an Elasticsearch #### Default Search Strategy -One benefit of using the low level search API, is partial response support in X-Pack, allowing for a better and more responsive user experience. +One benefit of using the low-level search API, is partial response support in X-Pack, allowing for a better and more responsive user experience. In OSS only the final result is returned. ```.ts