Elasticsearch legacy compatible api

docs/development/core/server/kibana-plugin-server.clusterclient.callasinternaluser.md → docs/development/core/server/kibana-plugin-server.clusterclient.callwithinternaluser.md

@@ -1,13 +1,13 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ClusterClient](./kibana-plugin-server.clusterclient.md) &gt; [callAsInternalUser](./kibana-plugin-server.clusterclient.callasinternaluser.md)
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ClusterClient](./kibana-plugin-server.clusterclient.md) &gt; [callWithInternalUser](./kibana-plugin-server.clusterclient.callwithinternaluser.md)
 
-## ClusterClient.callAsInternalUser property
+## ClusterClient.callWithInternalUser property
 
 Calls specified endpoint with provided clientParams on behalf of the Kibana internal user.
 
 <b>Signature:</b>
 
 ```typescript
-callAsInternalUser: (endpoint: string, clientParams?: Record<string, unknown>, options?: CallAPIOptions | undefined) => Promise<any>;
+callWithInternalUser: (endpoint: string, clientParams?: Record<string, unknown>, options?: CallAPIOptions | undefined) => Promise<any>;
 ```

docs/development/core/server/kibana-plugin-server.clusterclient.callwithrequest.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ClusterClient](./kibana-plugin-server.clusterclient.md) &gt; [callWithRequest](./kibana-plugin-server.clusterclient.callwithrequest.md)
+
+## ClusterClient.callWithRequest property
+
+Calls specified `endpoint` with provided `clientParams` on behalf of the user initiated request to the Kibana server (via HTTP request headers).
+
+<b>Signature:</b>
+
+```typescript
+callWithRequest: (request: Request | KibanaRequest<unknown, unknown, unknown> | FakeRequest, endpoint: string, clientParams?: Record<string, unknown>, options?: CallAPIOptions | undefined) => Promise<any>;
+```

docs/development/core/server/kibana-plugin-server.clusterclient.md

@@ -4,7 +4,7 @@
 
 ## ClusterClient class
 
-Represents an Elasticsearch cluster API client and allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via `asScoped(...)`<!-- -->).
+Represents an Elasticsearch cluster API client and allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers.
 
 <b>Signature:</b>
 
@@ -22,12 +22,12 @@ export declare class ClusterClient
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [callAsInternalUser](./kibana-plugin-server.clusterclient.callasinternaluser.md) |  | <code>(endpoint: string, clientParams?: Record&lt;string, unknown&gt;, options?: CallAPIOptions &#124; undefined) =&gt; Promise&lt;any&gt;</code> | Calls specified endpoint with provided clientParams on behalf of the Kibana internal user. |
+|  [callWithInternalUser](./kibana-plugin-server.clusterclient.callwithinternaluser.md) |  | <code>(endpoint: string, clientParams?: Record&lt;string, unknown&gt;, options?: CallAPIOptions &#124; undefined) =&gt; Promise&lt;any&gt;</code> | Calls specified endpoint with provided clientParams on behalf of the Kibana internal user. |
+|  [callWithRequest](./kibana-plugin-server.clusterclient.callwithrequest.md) |  | <code>(request: Request &#124; KibanaRequest&lt;unknown, unknown, unknown&gt; &#124; FakeRequest, endpoint: string, clientParams?: Record&lt;string, unknown&gt;, options?: CallAPIOptions &#124; undefined) =&gt; Promise&lt;any&gt;</code> | Calls specified <code>endpoint</code> with provided <code>clientParams</code> on behalf of the user initiated request to the Kibana server (via HTTP request headers). |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [asScoped(request)](./kibana-plugin-server.clusterclient.asscoped.md) |  | Creates an instance of <code>ScopedClusterClient</code> based on the configuration the current cluster client that exposes additional <code>callAsCurrentUser</code> method scoped to the provided req. Consumers shouldn't worry about closing scoped client instances, these will be automatically closed as soon as the original cluster client isn't needed anymore and closed. |
 |  [close()](./kibana-plugin-server.clusterclient.close.md) |  | Closes the cluster client. After that client cannot be used and one should create a new client instance to be able to interact with Elasticsearch API. |
 

docs/development/core/server/kibana-plugin-server.elasticsearcherrorhelpers.md

@@ -25,7 +25,7 @@ Handle errors
 
 ```js
 try {
-  await client.asScoped(request).callAsCurrentUser(...);
+  await client.callWithRequest(request, ...)
 } catch (err) {
   if (ElasticsearchErrorHelpers.isNotAuthorizedError(err)) {
     const authHeader = err.output.headers['WWW-Authenticate'];

docs/development/core/server/kibana-plugin-server.elasticsearchservicesetup.createclient.md

@@ -17,7 +17,7 @@ readonly createClient: (type: string, clientConfig?: Partial<ElasticsearchClient
 
 ```js
 const client = elasticsearch.createCluster('my-app-name', config);
-const data = await client.callAsInternalUser();
+const data = await client.callWithInternalUser();
 
 ```
 

docs/development/core/server/kibana-plugin-server.md

@@ -14,12 +14,11 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 
 |  Class | Description |
 |  --- | --- |
-|  [ClusterClient](./kibana-plugin-server.clusterclient.md) | Represents an Elasticsearch cluster API client and allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via <code>asScoped(...)</code>). |
+|  [ClusterClient](./kibana-plugin-server.clusterclient.md) | Represents an Elasticsearch cluster API client and allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers. |
 |  [ElasticsearchErrorHelpers](./kibana-plugin-server.elasticsearcherrorhelpers.md) | Helpers for working with errors returned from the Elasticsearch service.Since the internal data of errors are subject to change, consumers of the Elasticsearch service should always use these helpers to classify errors instead of checking error internals such as <code>body.error.header[WWW-Authenticate]</code> |
 |  [KibanaRequest](./kibana-plugin-server.kibanarequest.md) | Kibana specific abstraction for an incoming request. |
 |  [Router](./kibana-plugin-server.router.md) |  |
 |  [SavedObjectsErrorHelpers](./kibana-plugin-server.savedobjectserrorhelpers.md) |  |
-|  [ScopedClusterClient](./kibana-plugin-server.scopedclusterclient.md) | Serves the same purpose as "normal" <code>ClusterClient</code> but exposes additional <code>callAsCurrentUser</code> method that doesn't use credentials of the Kibana internal user (as <code>callAsInternalUser</code> does) to request Elasticsearch API, but rather passes HTTP headers extracted from the current user request to the API |
 
 ## Interfaces
 
@@ -70,7 +69,6 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 
 |  Type Alias | Description |
 |  --- | --- |
-|  [APICaller](./kibana-plugin-server.apicaller.md) |  |
 |  [AuthenticationHandler](./kibana-plugin-server.authenticationhandler.md) |  |
 |  [AuthHeaders](./kibana-plugin-server.authheaders.md) | Auth Headers map |
 |  [ElasticsearchClientConfig](./kibana-plugin-server.elasticsearchclientconfig.md) |  |

src/core/server/elasticsearch/cluster_client.test.mocks.ts

@@ -19,16 +19,10 @@
 
 export const MockClient = jest.fn();
 jest.mock('elasticsearch', () => ({
-  // Jest types don't include `requireActual` right now.
   ...jest.requireActual('elasticsearch'),
   Client: MockClient,
 }));
 
-export const MockScopedClusterClient = jest.fn();
-jest.mock('./scoped_cluster_client', () => ({
-  ScopedClusterClient: MockScopedClusterClient,
-}));
-
 export const mockParseElasticsearchClientConfig = jest.fn();
 jest.mock('./elasticsearch_client_config', () => ({
   parseElasticsearchClientConfig: mockParseElasticsearchClientConfig,