Skip to content

Commit 5c124f8

Browse files
committed
Update generated docs.
1 parent 9c7a967 commit 5c124f8

5 files changed

+33
-7
lines changed

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsource.getfields.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ getFields(): {
2121
size?: number | undefined;
2222
source?: string | boolean | string[] | undefined;
2323
version?: boolean | undefined;
24-
fields?: string | boolean | string[] | undefined;
24+
fields?: SearchFieldValue[] | undefined;
25+
fieldsFromSource?: string | boolean | string[] | undefined;
2526
index?: import("../..").IndexPattern | undefined;
2627
searchAfter?: import("./types").EsQuerySearchAfter | undefined;
2728
timeout?: string | undefined;
@@ -42,7 +43,8 @@ getFields(): {
4243
size?: number | undefined;
4344
source?: string | boolean | string[] | undefined;
4445
version?: boolean | undefined;
45-
fields?: string | boolean | string[] | undefined;
46+
fields?: SearchFieldValue[] | undefined;
47+
fieldsFromSource?: string | boolean | string[] | undefined;
4648
index?: import("../..").IndexPattern | undefined;
4749
searchAfter?: import("./types").EsQuerySearchAfter | undefined;
4850
timeout?: string | undefined;

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsourcefields.fields.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44

55
## SearchSourceFields.fields property
66

7+
Retrieve fields via the search Fields API
8+
79
<b>Signature:</b>
810

911
```typescript
10-
fields?: NameList;
12+
fields?: SearchFieldValue[];
1113
```
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[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)
4+
5+
## SearchSourceFields.fieldsFromSource property
6+
7+
> Warning: This API is now obsolete.
8+
>
9+
> It is recommended to use `fields` wherever possible.
10+
>
11+
12+
Retreive fields directly from \_source (legacy behavior)
13+
14+
<b>Signature:</b>
15+
16+
```typescript
17+
fieldsFromSource?: NameList;
18+
```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsourcefields.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ export interface SearchSourceFields
1717
| Property | Type | Description |
1818
| --- | --- | --- |
1919
| [aggs](./kibana-plugin-plugins-data-public.searchsourcefields.aggs.md) | <code>any</code> | [AggConfigs](./kibana-plugin-plugins-data-public.aggconfigs.md) |
20-
| [fields](./kibana-plugin-plugins-data-public.searchsourcefields.fields.md) | <code>NameList</code> | |
20+
| [fields](./kibana-plugin-plugins-data-public.searchsourcefields.fields.md) | <code>SearchFieldValue[]</code> | Retrieve fields via the search Fields API |
21+
| [fieldsFromSource](./kibana-plugin-plugins-data-public.searchsourcefields.fieldsfromsource.md) | <code>NameList</code> | Retreive fields directly from \_source (legacy behavior) |
2122
| [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) |
2223
| [from](./kibana-plugin-plugins-data-public.searchsourcefields.from.md) | <code>number</code> | |
2324
| [highlight](./kibana-plugin-plugins-data-public.searchsourcefields.highlight.md) | <code>any</code> | |

src/plugins/data/public/public.api.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2158,7 +2158,8 @@ export class SearchSource {
21582158
size?: number | undefined;
21592159
source?: string | boolean | string[] | undefined;
21602160
version?: boolean | undefined;
2161-
fields?: string | boolean | string[] | undefined;
2161+
fields?: SearchFieldValue[] | undefined;
2162+
fieldsFromSource?: string | boolean | string[] | undefined;
21622163
index?: import("../..").IndexPattern | undefined;
21632164
searchAfter?: import("./types").EsQuerySearchAfter | undefined;
21642165
timeout?: string | undefined;
@@ -2192,8 +2193,9 @@ export class SearchSource {
21922193
export interface SearchSourceFields {
21932194
// (undocumented)
21942195
aggs?: any;
2195-
// (undocumented)
2196-
fields?: NameList;
2196+
fields?: SearchFieldValue[];
2197+
// @deprecated
2198+
fieldsFromSource?: NameList;
21972199
// (undocumented)
21982200
filter?: Filter[] | Filter | (() => Filter[] | Filter | undefined);
21992201
// (undocumented)
@@ -2382,6 +2384,7 @@ export const UI_SETTINGS: {
23822384
// src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts:64:5 - (ae-forgotten-export) The symbol "FormatFieldFn" needs to be exported by the entry point index.d.ts
23832385
// src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts:135:7 - (ae-forgotten-export) The symbol "FieldAttrSet" needs to be exported by the entry point index.d.ts
23842386
// src/plugins/data/common/search/aggs/types.ts:113:51 - (ae-forgotten-export) The symbol "AggTypesRegistryStart" needs to be exported by the entry point index.d.ts
2387+
// src/plugins/data/common/search/search_source/search_source.ts:197:7 - (ae-forgotten-export) The symbol "SearchFieldValue" needs to be exported by the entry point index.d.ts
23852388
// src/plugins/data/public/field_formats/field_formats_service.ts:67:3 - (ae-forgotten-export) The symbol "FormatFactory" needs to be exported by the entry point index.d.ts
23862389
// src/plugins/data/public/index.ts:66:23 - (ae-forgotten-export) The symbol "FILTERS" needs to be exported by the entry point index.d.ts
23872390
// src/plugins/data/public/index.ts:66:23 - (ae-forgotten-export) The symbol "getDisplayValueFromFilter" needs to be exported by the entry point index.d.ts

0 commit comments

Comments
 (0)