Skip to content

Commit 9c7190d

Browse files
committed
updating docs
1 parent ecaa4b4 commit 9c7190d

File tree

5 files changed

+17
-10
lines changed

5 files changed

+17
-10
lines changed

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

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,8 @@ returns all search source fields
99
<b>Signature:</b>
1010

1111
```typescript
12-
getFields(recurse?: boolean): SearchSourceFields;
12+
getFields(): SearchSourceFields;
1313
```
14-
15-
## Parameters
16-
17-
| Parameter | Type | Description |
18-
| --- | --- | --- |
19-
| recurse | <code>boolean</code> | |
20-
2114
<b>Returns:</b>
2215

2316
`SearchSourceFields`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export declare class SearchSource
3535
| [fetch(options)](./kibana-plugin-plugins-data-public.searchsource.fetch.md) | | Fetch this source and reject the returned Promise on error |
3636
| [fetch$(options)](./kibana-plugin-plugins-data-public.searchsource.fetch_.md) | | Fetch this source from Elasticsearch, returning an observable over the response(s) |
3737
| [getField(field, recurse)](./kibana-plugin-plugins-data-public.searchsource.getfield.md) | | Gets a single field from the fields |
38-
| [getFields(recurse)](./kibana-plugin-plugins-data-public.searchsource.getfields.md) | | returns all search source fields |
38+
| [getFields()](./kibana-plugin-plugins-data-public.searchsource.getfields.md) | | returns all search source fields |
3939
| [getId()](./kibana-plugin-plugins-data-public.searchsource.getid.md) | | returns search source id |
4040
| [getOwnField(field)](./kibana-plugin-plugins-data-public.searchsource.getownfield.md) | | Get the field from our own fields, don't traverse up the chain |
4141
| [getParent()](./kibana-plugin-plugins-data-public.searchsource.getparent.md) | | Get the parent of this SearchSource {<!-- -->undefined\|searchSource<!-- -->} |

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ export interface SearchSourceFields
2424
| [highlight](./kibana-plugin-plugins-data-public.searchsourcefields.highlight.md) | <code>any</code> | |
2525
| [highlightAll](./kibana-plugin-plugins-data-public.searchsourcefields.highlightall.md) | <code>boolean</code> | |
2626
| [index](./kibana-plugin-plugins-data-public.searchsourcefields.index.md) | <code>IndexPattern</code> | |
27+
| [parent](./kibana-plugin-plugins-data-public.searchsourcefields.parent.md) | <code>SearchSourceFields</code> | |
2728
| [query](./kibana-plugin-plugins-data-public.searchsourcefields.query.md) | <code>Query</code> | [Query](./kibana-plugin-plugins-data-public.query.md) |
2829
| [searchAfter](./kibana-plugin-plugins-data-public.searchsourcefields.searchafter.md) | <code>EsQuerySearchAfter</code> | |
2930
| [size](./kibana-plugin-plugins-data-public.searchsourcefields.size.md) | <code>number</code> | |
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [parent](./kibana-plugin-plugins-data-public.searchsourcefields.parent.md)
4+
5+
## SearchSourceFields.parent property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
parent?: SearchSourceFields;
11+
```

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2379,7 +2379,7 @@ export class SearchSource {
23792379
// @deprecated
23802380
fetch(options?: ISearchOptions): Promise<import("elasticsearch").SearchResponse<any>>;
23812381
getField<K extends keyof SearchSourceFields>(field: K, recurse?: boolean): SearchSourceFields[K];
2382-
getFields(recurse?: boolean): SearchSourceFields;
2382+
getFields(): SearchSourceFields;
23832383
getId(): string;
23842384
getOwnField<K extends keyof SearchSourceFields>(field: K): SearchSourceFields[K];
23852385
getParent(): SearchSource | undefined;
@@ -2425,6 +2425,8 @@ export interface SearchSourceFields {
24252425
// (undocumented)
24262426
index?: IndexPattern;
24272427
// (undocumented)
2428+
parent?: SearchSourceFields;
2429+
// (undocumented)
24282430
query?: Query;
24292431
// Warning: (ae-forgotten-export) The symbol "EsQuerySearchAfter" needs to be exported by the entry point index.d.ts
24302432
//

0 commit comments

Comments
 (0)