[Search][Sessions] Rename Background Sessions to Search Sessions (#87500

) * Rename Background Sessions to Search Sessions (with a send to background action) * doc * doc * jest fun * rename rfc * translations * update so name in features Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
elastic · Jan 7, 2021 · 91aed6f · 91aed6f
1 parent 130a8e7
commit 91aed6f
Show file tree

Hide file tree

Showing 54 changed files with 417 additions and 472 deletions.
diff --git a/...velopment/plugins/data/public/kibana-plugin-plugins-data-public.isearchsetup.md b/...velopment/plugins/data/public/kibana-plugin-plugins-data-public.isearchsetup.md
@@ -18,6 +18,6 @@ export interface ISearchSetup
 |  --- | --- | --- |
 |  [aggs](./kibana-plugin-plugins-data-public.isearchsetup.aggs.md) | <code>AggsSetup</code> |  |
 |  [session](./kibana-plugin-plugins-data-public.isearchsetup.session.md) | <code>ISessionService</code> | Current session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) |
-|  [sessionsClient](./kibana-plugin-plugins-data-public.isearchsetup.sessionsclient.md) | <code>ISessionsClient</code> | Background search sessions SO CRUD [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md) |
+|  [sessionsClient](./kibana-plugin-plugins-data-public.isearchsetup.sessionsclient.md) | <code>ISessionsClient</code> | Search sessions SO CRUD [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md) |
 |  [usageCollector](./kibana-plugin-plugins-data-public.isearchsetup.usagecollector.md) | <code>SearchUsageCollector</code> |  |
 
diff --git a/...ns/data/public/kibana-plugin-plugins-data-public.isearchsetup.sessionsclient.md b/...ns/data/public/kibana-plugin-plugins-data-public.isearchsetup.sessionsclient.md
@@ -4,7 +4,7 @@
 
 ## ISearchSetup.sessionsClient property
 
-Background search sessions SO CRUD [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md)
+Search sessions SO CRUD [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md)
 
 <b>Signature:</b>
 

diff --git a/...velopment/plugins/data/public/kibana-plugin-plugins-data-public.isearchstart.md b/...velopment/plugins/data/public/kibana-plugin-plugins-data-public.isearchstart.md
@@ -20,6 +20,6 @@ export interface ISearchStart
 |  [search](./kibana-plugin-plugins-data-public.isearchstart.search.md) | <code>ISearchGeneric</code> | low level search [ISearchGeneric](./kibana-plugin-plugins-data-public.isearchgeneric.md) |
 |  [searchSource](./kibana-plugin-plugins-data-public.isearchstart.searchsource.md) | <code>ISearchStartSearchSource</code> | high level search [ISearchStartSearchSource](./kibana-plugin-plugins-data-public.isearchstartsearchsource.md) |
 |  [session](./kibana-plugin-plugins-data-public.isearchstart.session.md) | <code>ISessionService</code> | Current session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) |
-|  [sessionsClient](./kibana-plugin-plugins-data-public.isearchstart.sessionsclient.md) | <code>ISessionsClient</code> | Background search sessions SO CRUD [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md) |
+|  [sessionsClient](./kibana-plugin-plugins-data-public.isearchstart.sessionsclient.md) | <code>ISessionsClient</code> | Search sessions SO CRUD [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md) |
 |  [showError](./kibana-plugin-plugins-data-public.isearchstart.showerror.md) | <code>(e: Error) =&gt; void</code> |  |
 
diff --git a/...ns/data/public/kibana-plugin-plugins-data-public.isearchstart.sessionsclient.md b/...ns/data/public/kibana-plugin-plugins-data-public.isearchstart.sessionsclient.md
@@ -4,7 +4,7 @@
 
 ## ISearchStart.sessionsClient property
 
-Background search sessions SO CRUD [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md)
+Search sessions SO CRUD [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md)
 
 <b>Signature:</b>
 

diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md
@@ -34,7 +34,7 @@
 |  [KBN\_FIELD\_TYPES](./kibana-plugin-plugins-data-public.kbn_field_types.md) | \* |
 |  [METRIC\_TYPES](./kibana-plugin-plugins-data-public.metric_types.md) |  |
 |  [QuerySuggestionTypes](./kibana-plugin-plugins-data-public.querysuggestiontypes.md) |  |
-|  [SessionState](./kibana-plugin-plugins-data-public.sessionstate.md) | Possible state that current session can be in |
+|  [SearchSessionState](./kibana-plugin-plugins-data-public.searchsessionstate.md) | Possible state that current session can be in |
 |  [SortDirection](./kibana-plugin-plugins-data-public.sortdirection.md) |  |
 |  [TimeoutErrorMode](./kibana-plugin-plugins-data-public.timeouterrormode.md) |  |
 
@@ -90,7 +90,7 @@
 |  [SavedQueryService](./kibana-plugin-plugins-data-public.savedqueryservice.md) |  |
 |  [SearchError](./kibana-plugin-plugins-data-public.searcherror.md) |  |
 |  [SearchInterceptorDeps](./kibana-plugin-plugins-data-public.searchinterceptordeps.md) |  |
-|  [SearchSessionInfoProvider](./kibana-plugin-plugins-data-public.searchsessioninfoprovider.md) | Provide info about current search session to be stored in backgroundSearch saved object |
+|  [SearchSessionInfoProvider](./kibana-plugin-plugins-data-public.searchsessioninfoprovider.md) | Provide info about current search session to be stored in the Search Session saved object |
 |  [SearchSourceFields](./kibana-plugin-plugins-data-public.searchsourcefields.md) | search source fields |
 |  [TabbedAggColumn](./kibana-plugin-plugins-data-public.tabbedaggcolumn.md) | \* |
 |  [TabbedTable](./kibana-plugin-plugins-data-public.tabbedtable.md) | \* |

diff --git a/...a/public/kibana-plugin-plugins-data-public.searchsessioninfoprovider.getname.md b/...a/public/kibana-plugin-plugins-data-public.searchsessioninfoprovider.getname.md
@@ -4,7 +4,7 @@
 
 ## SearchSessionInfoProvider.getName property
 
-User-facing name of the session. e.g. will be displayed in background sessions management list
+User-facing name of the session. e.g. will be displayed in saved Search Sessions management list
 
 <b>Signature:</b>
 

diff --git a/...gins/data/public/kibana-plugin-plugins-data-public.searchsessioninfoprovider.md b/...gins/data/public/kibana-plugin-plugins-data-public.searchsessioninfoprovider.md
@@ -4,7 +4,7 @@
 
 ## SearchSessionInfoProvider interface
 
-Provide info about current search session to be stored in backgroundSearch saved object
+Provide info about current search session to be stored in the Search Session saved object
 
 <b>Signature:</b>
 
@@ -16,6 +16,6 @@ export interface SearchSessionInfoProvider<ID extends UrlGeneratorId = UrlGenera
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [getName](./kibana-plugin-plugins-data-public.searchsessioninfoprovider.getname.md) | <code>() =&gt; Promise&lt;string&gt;</code> | User-facing name of the session. e.g. will be displayed in background sessions management list |
+|  [getName](./kibana-plugin-plugins-data-public.searchsessioninfoprovider.getname.md) | <code>() =&gt; Promise&lt;string&gt;</code> | User-facing name of the session. e.g. will be displayed in saved Search Sessions management list |
 |  [getUrlGeneratorData](./kibana-plugin-plugins-data-public.searchsessioninfoprovider.geturlgeneratordata.md) | <code>() =&gt; Promise&lt;{</code><br/><code>        urlGeneratorId: ID;</code><br/><code>        initialState: UrlGeneratorStateMapping[ID]['State'];</code><br/><code>        restoreState: UrlGeneratorStateMapping[ID]['State'];</code><br/><code>    }&gt;</code> |  |
 
diff --git a/...lugin-plugins-data-public.sessionstate.md → ...plugins-data-public.searchsessionstate.md b/...lugin-plugins-data-public.sessionstate.md → ...plugins-data-public.searchsessionstate.md
@@ -1,25 +1,25 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [SessionState](./kibana-plugin-plugins-data-public.sessionstate.md)
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [SearchSessionState](./kibana-plugin-plugins-data-public.searchsessionstate.md)
 
-## SessionState enum
+## SearchSessionState enum
 
 Possible state that current session can be in
 
 <b>Signature:</b>
 
 ```typescript
-export declare enum SessionState 
+export declare enum SearchSessionState 
 ```
 
 ## Enumeration Members
 
 |  Member | Value | Description |
 |  --- | --- | --- |
-|  BackgroundCompleted | <code>&quot;backgroundCompleted&quot;</code> | Page load completed with background session created. |
-|  BackgroundLoading | <code>&quot;backgroundLoading&quot;</code> | Search request was sent to the background. The page is loading in background. |
+|  BackgroundCompleted | <code>&quot;backgroundCompleted&quot;</code> | Page load completed with search session created. |
+|  BackgroundLoading | <code>&quot;backgroundLoading&quot;</code> | Search session was sent to the background. The page is loading in background. |
 |  Canceled | <code>&quot;canceled&quot;</code> | Current session requests where explicitly canceled by user Displaying none or partial results |
-|  Completed | <code>&quot;completed&quot;</code> | No action was taken and the page completed loading without background session creation. |
+|  Completed | <code>&quot;completed&quot;</code> | No action was taken and the page completed loading without search session creation. |
 |  Loading | <code>&quot;loading&quot;</code> | Pending search request has not been sent to the background yet |
 |  None | <code>&quot;none&quot;</code> | Session is not active, e.g. didn't start |
 |  Restored | <code>&quot;restored&quot;</code> | Revisiting the page after background completion |

diff --git a/examples/search_examples/public/components/app.tsx b/examples/search_examples/public/components/app.tsx
@@ -295,7 +295,7 @@ export const SearchExamplesApp = ({
                             <EuiFormLabel>Index Pattern</EuiFormLabel>
                             <IndexPatternSelect
                               placeholder={i18n.translate(
-                                'backgroundSessionExample.selectIndexPatternPlaceholder',
+                                'searchSessionExample.selectIndexPatternPlaceholder',
                                 {
                                   defaultMessage: 'Select index pattern',
                                 }

diff --git a/rfcs/images/background_sessions_client.png → rfcs/images/search_sessions_client.png b/rfcs/images/background_sessions_client.png → rfcs/images/search_sessions_client.png
diff --git a/rfcs/images/background_sessions_server.png → rfcs/images/search_sessions_server.png b/rfcs/images/background_sessions_server.png → rfcs/images/search_sessions_server.png