[data.search.searchSource] Update SearchSource to use Fields API. (#8…

…2383) (#84915)
elastic · Dec 3, 2020 · 85533fc · 85533fc
1 parent 9a8351c
commit 85533fc
Show file tree

Hide file tree

Showing 23 changed files with 834 additions and 312 deletions.
diff --git a/...plugins/data/public/kibana-plugin-plugins-data-public.searchsource.getfields.md b/...plugins/data/public/kibana-plugin-plugins-data-public.searchsource.getfields.md
@@ -21,7 +21,8 @@ getFields(): {
         size?: number | undefined;
         source?: string | boolean | string[] | undefined;
         version?: boolean | undefined;
-        fields?: string | boolean | string[] | undefined;
+        fields?: SearchFieldValue[] | undefined;
+        fieldsFromSource?: string | boolean | string[] | undefined;
         index?: import("../..").IndexPattern | undefined;
         searchAfter?: import("./types").EsQuerySearchAfter | undefined;
         timeout?: string | undefined;
@@ -42,7 +43,8 @@ getFields(): {
         size?: number | undefined;
         source?: string | boolean | string[] | undefined;
         version?: boolean | undefined;
-        fields?: string | boolean | string[] | undefined;
+        fields?: SearchFieldValue[] | undefined;
+        fieldsFromSource?: string | boolean | string[] | undefined;
         index?: import("../..").IndexPattern | undefined;
         searchAfter?: import("./types").EsQuerySearchAfter | undefined;
         timeout?: string | undefined;

diff --git a/...gins/data/public/kibana-plugin-plugins-data-public.searchsourcefields.fields.md b/...gins/data/public/kibana-plugin-plugins-data-public.searchsourcefields.fields.md
@@ -4,8 +4,10 @@
 
 ## SearchSourceFields.fields property
 
+Retrieve fields via the search Fields API
+
 <b>Signature:</b>
 
 ```typescript
-fields?: NameList;
+fields?: SearchFieldValue[];
 ```
diff --git a/...public/kibana-plugin-plugins-data-public.searchsourcefields.fieldsfromsource.md b/...public/kibana-plugin-plugins-data-public.searchsourcefields.fieldsfromsource.md
@@ -0,0 +1,18 @@
+<!-- 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; [SearchSourceFields](./kibana-plugin-plugins-data-public.searchsourcefields.md) &gt; [fieldsFromSource](./kibana-plugin-plugins-data-public.searchsourcefields.fieldsfromsource.md)
+
+## SearchSourceFields.fieldsFromSource property
+
+> Warning: This API is now obsolete.
+> 
+> It is recommended to use `fields` wherever possible.
+> 
+
+Retreive fields directly from \_source (legacy behavior)
+
+<b>Signature:</b>
+
+```typescript
+fieldsFromSource?: NameList;
+```
diff --git a/...ent/plugins/data/public/kibana-plugin-plugins-data-public.searchsourcefields.md b/...ent/plugins/data/public/kibana-plugin-plugins-data-public.searchsourcefields.md
@@ -17,7 +17,8 @@ export interface SearchSourceFields
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [aggs](./kibana-plugin-plugins-data-public.searchsourcefields.aggs.md) | <code>any</code> | [AggConfigs](./kibana-plugin-plugins-data-public.aggconfigs.md) |
-|  [fields](./kibana-plugin-plugins-data-public.searchsourcefields.fields.md) | <code>NameList</code> |  |
+|  [fields](./kibana-plugin-plugins-data-public.searchsourcefields.fields.md) | <code>SearchFieldValue[]</code> | Retrieve fields via the search Fields API |
+|  [fieldsFromSource](./kibana-plugin-plugins-data-public.searchsourcefields.fieldsfromsource.md) | <code>NameList</code> | Retreive fields directly from \_source (legacy behavior) |
 |  [filter](./kibana-plugin-plugins-data-public.searchsourcefields.filter.md) | <code>Filter[] &#124; Filter &#124; (() =&gt; Filter[] &#124; Filter &#124; undefined)</code> | [Filter](./kibana-plugin-plugins-data-public.filter.md) |
 |  [from](./kibana-plugin-plugins-data-public.searchsourcefields.from.md) | <code>number</code> |  |
 |  [highlight](./kibana-plugin-plugins-data-public.searchsourcefields.highlight.md) | <code>any</code> |  |