fix(client): Rename client.updateKey => client.updateApiKey

Closes #423
algolia · Jan 15, 2018 · 6306107 · 6306107
1 parent ab7583d
commit 6306107
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 11 deletions.
diff --git a/algoliasearch-common/src/main/java/com/algolia/search/APIClient.java b/algoliasearch-common/src/main/java/com/algolia/search/APIClient.java
@@ -342,7 +342,7 @@ public CreateUpdateKey addApiKey(@Nonnull ApiKey key, @Nonnull RequestOptions re
             .setData(key));
   }
 
-  /** Deprecated: use updateApiKey */
+  /** Deprecated: use {@link #updateApiKey(String, ApiKey)} */
   @Deprecated
   public CreateUpdateKey updateKey(@Nonnull String keyName, @Nonnull ApiKey key)
       throws AlgoliaException {
@@ -862,7 +862,7 @@ CreateUpdateKey addKey(String indexName, ApiKey key, RequestOptions requestOptio
             .setData(key));
   }
 
-  CreateUpdateKey updateKey(
+  CreateUpdateKey updateApiKey(
       String indexName, String keyName, ApiKey key, RequestOptions requestOptions)
       throws AlgoliaException {
     return httpClient.requestWithRetry(

diff --git a/algoliasearch-common/src/main/java/com/algolia/search/AsyncAPIClient.java b/algoliasearch-common/src/main/java/com/algolia/search/AsyncAPIClient.java
@@ -308,7 +308,7 @@ public CompletableFuture<CreateUpdateKey> addApiKey(
             .setData(key));
   }
 
-  /** Deprecated: use updateApiKey */
+  /** Deprecated: use ${@link #updateApiKey(String, ApiKey)} */
   @Deprecated
   public CompletableFuture<CreateUpdateKey> updateKey(
       @Nonnull String keyName, @Nonnull ApiKey key) {
@@ -838,7 +838,7 @@ CompletableFuture<CreateUpdateKey> addKey(
             .setData(key));
   }
 
-  CompletableFuture<CreateUpdateKey> updateKey(
+  CompletableFuture<CreateUpdateKey> updateApiKey(
       String indexName, String keyName, ApiKey key, RequestOptions requestOptions) {
     return httpClient.requestWithRetry(
         new AlgoliaRequest<>(

diff --git a/algoliasearch-common/src/main/java/com/algolia/search/AsyncIndex.java b/algoliasearch-common/src/main/java/com/algolia/search/AsyncIndex.java
@@ -613,7 +613,7 @@ default CompletableFuture<CreateUpdateKey> addApiKey(
     return getApiClient().addKey(getName(), key, requestOptions);
   }
 
-  /** Deprecated: use updateApiKey */
+  /** Deprecated: use {@link #updateApiKey(String, ApiKey)} */
   @Deprecated
   default CompletableFuture<CreateUpdateKey> updateKey(
       @Nonnull String keyName, @Nonnull ApiKey key) {
@@ -642,7 +642,7 @@ default CompletableFuture<CreateUpdateKey> updateApiKey(
    */
   default CompletableFuture<CreateUpdateKey> updateApiKey(
       @Nonnull String keyName, @Nonnull ApiKey key, @Nonnull RequestOptions requestOptions) {
-    return getApiClient().updateKey(getName(), keyName, key, requestOptions);
+    return getApiClient().updateApiKey(getName(), keyName, key, requestOptions);
   }
 }
 

diff --git a/algoliasearch-common/src/main/java/com/algolia/search/Index.java b/algoliasearch-common/src/main/java/com/algolia/search/Index.java
@@ -676,6 +676,13 @@ default CreateUpdateKey addApiKey(@Nonnull ApiKey key, @Nonnull RequestOptions r
     return getApiClient().addKey(getName(), key, requestOptions);
   }
 
+  /** Deprecated: use {@link #updateApiKey(String, ApiKey)} */
+  @Deprecated
+  default CreateUpdateKey updateKey(@Nonnull String keyName, @Nonnull ApiKey key)
+      throws AlgoliaException {
+    return updateApiKey(keyName, key, RequestOptions.empty);
+  }
+
   /**
    * Update a key by name from this index
    *
@@ -684,9 +691,17 @@ default CreateUpdateKey addApiKey(@Nonnull ApiKey key, @Nonnull RequestOptions r
    * @return the updated key
    * @throws AlgoliaException
    */
-  default CreateUpdateKey updateKey(@Nonnull String keyName, @Nonnull ApiKey key)
+  default CreateUpdateKey updateApiKey(@Nonnull String keyName, @Nonnull ApiKey key)
       throws AlgoliaException {
-    return updateKey(keyName, key, RequestOptions.empty);
+    return updateApiKey(keyName, key, RequestOptions.empty);
+  }
+
+  /** Deprecated: use {@link #updateApiKey(String, ApiKey, RequestOptions)} */
+  @Deprecated
+  default CreateUpdateKey updateKey(
+      @Nonnull String keyName, @Nonnull ApiKey key, @Nonnull RequestOptions requestOptions)
+      throws AlgoliaException {
+    return getApiClient().updateApiKey(getName(), keyName, key, requestOptions);
   }
 
   /**
@@ -698,10 +713,10 @@ default CreateUpdateKey updateKey(@Nonnull String keyName, @Nonnull ApiKey key)
    * @return the updated key
    * @throws AlgoliaException
    */
-  default CreateUpdateKey updateKey(
+  default CreateUpdateKey updateApiKey(
       @Nonnull String keyName, @Nonnull ApiKey key, @Nonnull RequestOptions requestOptions)
       throws AlgoliaException {
-    return getApiClient().updateKey(getName(), keyName, key, requestOptions);
+    return getApiClient().updateApiKey(getName(), keyName, key, requestOptions);
   }
 }
 

diff --git a/...earch-tests/src/test/java/com/algolia/search/integration/common/sync/SyncApiKeysTest.java b/...earch-tests/src/test/java/com/algolia/search/integration/common/sync/SyncApiKeysTest.java
@@ -106,7 +106,7 @@ public void manageKeysForIndex() throws AlgoliaException, InterruptedException {
     waitForKeyPresent(index, apiKey.getDescription());
 
     apiKey = apiKey.setDescription("toto2" + System.currentTimeMillis());
-    index.updateKey(keyName, apiKey);
+    index.updateApiKey(keyName, apiKey);
 
     waitForKeyPresent(index, apiKey.getDescription());