docs

elastic · Jul 13, 2020 · 7dbe5b4 · 7dbe5b4
1 parent c3bc240
commit 7dbe5b4
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 3 deletions.
diff --git a/...lopment/plugins/data/server/kibana-plugin-plugins-data-server.isearchoptions.md b/...lopment/plugins/data/server/kibana-plugin-plugins-data-server.isearchoptions.md
@@ -15,4 +15,5 @@ export interface ISearchOptions
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [signal](./kibana-plugin-plugins-data-server.isearchoptions.signal.md) | <code>AbortSignal</code> | An <code>AbortSignal</code> that allows the caller of <code>search</code> to abort a search request. |
+|  [strategy](./kibana-plugin-plugins-data-server.isearchoptions.strategy.md) | <code>string</code> |  |
 
diff --git a/...lugins/data/server/kibana-plugin-plugins-data-server.isearchoptions.strategy.md b/...lugins/data/server/kibana-plugin-plugins-data-server.isearchoptions.strategy.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; [ISearchOptions](./kibana-plugin-plugins-data-server.isearchoptions.md) &gt; [strategy](./kibana-plugin-plugins-data-server.isearchoptions.strategy.md)
+
+## ISearchOptions.strategy property
+
+<b>Signature:</b>
+
+```typescript
+strategy?: string;
+```
diff --git a/...velopment/plugins/data/server/kibana-plugin-plugins-data-server.isearchstart.md b/...velopment/plugins/data/server/kibana-plugin-plugins-data-server.isearchstart.md
@@ -15,5 +15,5 @@ export interface ISearchStart
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [getSearchStrategy](./kibana-plugin-plugins-data-server.isearchstart.getsearchstrategy.md) | <code>(name: string) =&gt; ISearchStrategy</code> | Get other registered search strategies. For example, if a new strategy needs to use the already-registered ES search strategy, it can use this function to accomplish that. |
-|  [search](./kibana-plugin-plugins-data-server.isearchstart.search.md) | <code>(context: RequestHandlerContext, request: IKibanaSearchRequest, options: any) =&gt; Promise&lt;IKibanaSearchResponse&gt;</code> |  |
+|  [search](./kibana-plugin-plugins-data-server.isearchstart.search.md) | <code>(context: RequestHandlerContext, request: IKibanaSearchRequest, options: ISearchOptions) =&gt; Promise&lt;IKibanaSearchResponse&gt;</code> |  |
 
diff --git a/...nt/plugins/data/server/kibana-plugin-plugins-data-server.isearchstart.search.md b/...nt/plugins/data/server/kibana-plugin-plugins-data-server.isearchstart.search.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-search: (context: RequestHandlerContext, request: IKibanaSearchRequest, options: any) => Promise<IKibanaSearchResponse>;
+search: (context: RequestHandlerContext, request: IKibanaSearchRequest, options: ISearchOptions) => Promise<IKibanaSearchResponse>;
 ```
diff --git a/src/plugins/data/server/server.api.md b/src/plugins/data/server/server.api.md
@@ -513,6 +513,8 @@ export class IndexPatternsFetcher {
 // @public (undocumented)
 export interface ISearchOptions {
     signal?: AbortSignal;
+    // (undocumented)
+    strategy?: string;
 }
 
 // Warning: (ae-missing-release-tag) "ISearchSetup" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -532,7 +534,7 @@ export interface ISearchStart {
     // Warning: (ae-forgotten-export) The symbol "IKibanaSearchResponse" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
-    search: (context: RequestHandlerContext, request: IKibanaSearchRequest, options: any) => Promise<IKibanaSearchResponse>;
+    search: (context: RequestHandlerContext, request: IKibanaSearchRequest, options: ISearchOptions) => Promise<IKibanaSearchResponse>;
 }
 
 // Warning: (ae-missing-release-tag) "ISearchStrategy" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)