feat: Deprecate API keys methods on Index in favor of Client ones

algolia · May 7, 2018 · e67c206 · e67c206
1 parent cd80f01
commit e67c206
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/src/main/scala/algolia/definitions/KeyDefinition.scala b/src/main/scala/algolia/definitions/KeyDefinition.scala
@@ -37,6 +37,7 @@ case class GetKeyDefinition(keyName: String,
 
   type T = GetKeyDefinition
 
+  @deprecated("use without index", "1.27.0")
   def from(indexName: String): GetKeyDefinition = copy(indexName = Some(indexName))
 
   override def options(requestOptions: RequestOptions): GetKeyDefinition =
@@ -65,6 +66,7 @@ case class AddKeyDefinition(
     extends Definition {
   type T = AddKeyDefinition
 
+  @deprecated("use without index", "1.27.0")
   def to(indexName: String): AddKeyDefinition = copy(indexName = Some(indexName))
 
   override def options(requestOptions: RequestOptions): AddKeyDefinition =
@@ -94,6 +96,7 @@ case class DeleteKeyDefinition(keyName: String,
 
   type T = DeleteKeyDefinition
 
+  @deprecated("use without index", "1.27.0")
   def from(indexName: String): DeleteKeyDefinition = copy(indexName = Some(indexName))
 
   override def options(requestOptions: RequestOptions): DeleteKeyDefinition =
@@ -126,6 +129,7 @@ case class UpdateKeyDefinition(
 
   def `with`(key: ApiKey): UpdateKeyDefinition = copy(key = Some(key))
 
+  @deprecated("use without index", "1.27.0")
   def from(indexName: String): UpdateKeyDefinition = copy(indexName = Some(indexName))
 
   override def options(requestOptions: RequestOptions): UpdateKeyDefinition =

diff --git a/src/main/scala/algolia/dsl/ListDsl.scala b/src/main/scala/algolia/dsl/ListDsl.scala
@@ -40,6 +40,7 @@ trait ListDsl {
 
     def keys = ListKeysDefinition()
 
+    @deprecated("use without index", "1.27.0")
     def keysFrom(indexName: String) =
       ListKeysDefinition(indexName = Some(indexName))
   }