address comments

elastic · May 29, 2020 · fcccf96 · fcccf96
1 parent 077d0d6
commit fcccf96
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 3 deletions.
diff --git a/...pment/core/server/kibana-plugin-core-server.elasticsearchservicesetup.legacy.md b/...pment/core/server/kibana-plugin-core-server.elasticsearchservicesetup.legacy.md
@@ -4,6 +4,11 @@
 
 ## ElasticsearchServiceSetup.legacy property
 
+> Warning: This API is now obsolete.
+> 
+> Use [ElasticsearchServiceStart.legacy](./kibana-plugin-core-server.elasticsearchservicestart.legacy.md) instead.
+> 
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/...pment/core/server/kibana-plugin-core-server.elasticsearchservicestart.legacy.md b/...pment/core/server/kibana-plugin-core-server.elasticsearchservicestart.legacy.md
@@ -4,6 +4,11 @@
 
 ## ElasticsearchServiceStart.legacy property
 
+> Warning: This API is now obsolete.
+> 
+> Provided for the backward compatibility. Switch to the new elasticsearch client as soon as https://github.com/elastic/kibana/issues/35508 done.
+> 
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/src/core/server/elasticsearch/elasticsearch_service.ts b/src/core/server/elasticsearch/elasticsearch_service.ts
@@ -94,7 +94,7 @@ export class ElasticsearchService
       switchMap(
         (config) =>
           new Observable<CoreClusterClients>((subscriber) => {
-            this.log.debug('Creating elasticsearch clients');
+            this.log.debug('Creating elasticsearch client');
 
             const coreClients = {
               config,

diff --git a/src/core/server/elasticsearch/types.ts b/src/core/server/elasticsearch/types.ts
@@ -28,6 +28,11 @@ import { ServiceStatus } from '../status';
  * @public
  */
 export interface ElasticsearchServiceSetup {
+  /**
+   * @deprecated
+   * Use {@link ElasticsearchServiceStart.legacy} instead.
+   *
+   * */
   legacy: {
     /**
      * @deprecated
@@ -74,6 +79,11 @@ export interface ElasticsearchServiceSetup {
  * @public
  */
 export interface ElasticsearchServiceStart {
+  /**
+   * @deprecated
+   * Provided for the backward compatibility.
+   * Switch to the new elasticsearch client as soon as https://github.com/elastic/kibana/issues/35508 done.
+   * */
   legacy: {
     /**
      * Create application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.

diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -822,7 +822,7 @@ export class ElasticsearchErrorHelpers {
 
 // @public (undocumented)
 export interface ElasticsearchServiceSetup {
-    // (undocumented)
+    // @deprecated (undocumented)
     legacy: {
         readonly createClient: (type: string, clientConfig?: Partial<ElasticsearchClientConfig>) => ICustomClusterClient;
         readonly client: IClusterClient;
@@ -831,7 +831,7 @@ export interface ElasticsearchServiceSetup {
 
 // @public (undocumented)
 export interface ElasticsearchServiceStart {
-    // (undocumented)
+    // @deprecated (undocumented)
     legacy: {
         readonly createClient: (type: string, clientConfig?: Partial<ElasticsearchClientConfig>) => ICustomClusterClient;
         readonly client: IClusterClient;