update service docs

elastic · May 26, 2021 · 5474508 · 5474508
1 parent 3a89bd2
commit 5474508
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 0 deletions.
diff --git a/...a/public/kibana-plugin-plugins-data-public.indexpatternsservice.getdefaultid.md b/...a/public/kibana-plugin-plugins-data-public.indexpatternsservice.getdefaultid.md
@@ -0,0 +1,11 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [getDefaultId](./kibana-plugin-plugins-data-public.indexpatternsservice.getdefaultid.md)
+
+## IndexPatternsService.getDefaultId property
+
+<b>Signature:</b>
+
+```typescript
+getDefaultId: () => Promise<string | null>;
+```
diff --git a/...t/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.md b/...t/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.md
@@ -27,6 +27,7 @@ export declare class IndexPatternsService
 |  [get](./kibana-plugin-plugins-data-public.indexpatternsservice.get.md) |  | <code>(id: string) =&gt; Promise&lt;IndexPattern&gt;</code> | Get an index pattern by id. Cache optimized |
 |  [getCache](./kibana-plugin-plugins-data-public.indexpatternsservice.getcache.md) |  | <code>() =&gt; Promise&lt;SavedObject&lt;IndexPatternSavedObjectAttrs&gt;[] &#124; null &#124; undefined&gt;</code> |  |
 |  [getDefault](./kibana-plugin-plugins-data-public.indexpatternsservice.getdefault.md) |  | <code>() =&gt; Promise&lt;IndexPattern &#124; null&gt;</code> | Get default index pattern |
+|  [getDefaultId](./kibana-plugin-plugins-data-public.indexpatternsservice.getdefaultid.md) |  | <code>() =&gt; Promise&lt;string &#124; null&gt;</code> |  |
 |  [getFieldsForIndexPattern](./kibana-plugin-plugins-data-public.indexpatternsservice.getfieldsforindexpattern.md) |  | <code>(indexPattern: IndexPattern &#124; IndexPatternSpec, options?: GetFieldsOptions &#124; undefined) =&gt; Promise&lt;any&gt;</code> | Get field list by providing an index patttern (or spec) |
 |  [getFieldsForWildcard](./kibana-plugin-plugins-data-public.indexpatternsservice.getfieldsforwildcard.md) |  | <code>(options: GetFieldsOptions) =&gt; Promise&lt;any&gt;</code> | Get field list by providing { pattern } |
 |  [getIds](./kibana-plugin-plugins-data-public.indexpatternsservice.getids.md) |  | <code>(refresh?: boolean) =&gt; Promise&lt;string[]&gt;</code> | Get list of index pattern ids |

diff --git a/...a/server/kibana-plugin-plugins-data-server.indexpatternsservice.getdefaultid.md b/...a/server/kibana-plugin-plugins-data-server.indexpatternsservice.getdefaultid.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IndexPatternsService](./kibana-plugin-plugins-data-server.indexpatternsservice.md) &gt; [getDefaultId](./kibana-plugin-plugins-data-server.indexpatternsservice.getdefaultid.md)
+
+## IndexPatternsService.getDefaultId property
+
+<b>Signature:</b>
+
+```typescript
+getDefaultId: () => Promise<string | null>;
+```
diff --git a/...t/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternsservice.md b/...t/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternsservice.md
@@ -27,6 +27,7 @@ export declare class IndexPatternsService
 |  [get](./kibana-plugin-plugins-data-server.indexpatternsservice.get.md) |  | <code>(id: string) =&gt; Promise&lt;IndexPattern&gt;</code> | Get an index pattern by id. Cache optimized |
 |  [getCache](./kibana-plugin-plugins-data-server.indexpatternsservice.getcache.md) |  | <code>() =&gt; Promise&lt;SavedObject&lt;IndexPatternSavedObjectAttrs&gt;[] &#124; null &#124; undefined&gt;</code> |  |
 |  [getDefault](./kibana-plugin-plugins-data-server.indexpatternsservice.getdefault.md) |  | <code>() =&gt; Promise&lt;IndexPattern &#124; null&gt;</code> | Get default index pattern |
+|  [getDefaultId](./kibana-plugin-plugins-data-server.indexpatternsservice.getdefaultid.md) |  | <code>() =&gt; Promise&lt;string &#124; null&gt;</code> |  |
 |  [getFieldsForIndexPattern](./kibana-plugin-plugins-data-server.indexpatternsservice.getfieldsforindexpattern.md) |  | <code>(indexPattern: IndexPattern &#124; IndexPatternSpec, options?: GetFieldsOptions &#124; undefined) =&gt; Promise&lt;any&gt;</code> | Get field list by providing an index patttern (or spec) |
 |  [getFieldsForWildcard](./kibana-plugin-plugins-data-server.indexpatternsservice.getfieldsforwildcard.md) |  | <code>(options: GetFieldsOptions) =&gt; Promise&lt;any&gt;</code> | Get field list by providing { pattern } |
 |  [getIds](./kibana-plugin-plugins-data-server.indexpatternsservice.getids.md) |  | <code>(refresh?: boolean) =&gt; Promise&lt;string[]&gt;</code> | Get list of index pattern ids |

diff --git a/.../server/kibana-plugin-plugins-data-server.searchstrategydependencies.request.md b/.../server/kibana-plugin-plugins-data-server.searchstrategydependencies.request.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [SearchStrategyDependencies](./kibana-plugin-plugins-data-server.searchstrategydependencies.md) &gt; [request](./kibana-plugin-plugins-data-server.searchstrategydependencies.request.md)
+
+## SearchStrategyDependencies.request property
+
+<b>Signature:</b>
+
+```typescript
+request: KibanaRequest;
+```
diff --git a/src/plugins/data/public/public.api.md b/src/plugins/data/public/public.api.md
@@ -1621,6 +1621,8 @@ export class IndexPatternsService {
     // (undocumented)
     getCache: () => Promise<SavedObject<IndexPatternSavedObjectAttrs>[] | null | undefined>;
     getDefault: () => Promise<IndexPattern | null>;
+    // (undocumented)
+    getDefaultId: () => Promise<string | null>;
     getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise<any>;
     // Warning: (ae-forgotten-export) The symbol "GetFieldsOptions" needs to be exported by the entry point index.d.ts
     getFieldsForWildcard: (options: GetFieldsOptions) => Promise<any>;

diff --git a/src/plugins/data/server/server.api.md b/src/plugins/data/server/server.api.md
@@ -962,6 +962,8 @@ class IndexPatternsService {
     // (undocumented)
     getCache: () => Promise<SavedObject_2<IndexPatternSavedObjectAttrs>[] | null | undefined>;
     getDefault: () => Promise<IndexPattern | null>;
+    // (undocumented)
+    getDefaultId: () => Promise<string | null>;
     getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise<any>;
     // Warning: (ae-forgotten-export) The symbol "GetFieldsOptions" needs to be exported by the entry point index.d.ts
     getFieldsForWildcard: (options: GetFieldsOptions) => Promise<any>;