fix(settings): Rename changeSettings in setSettings (#462)

Closes #452
algolia · Feb 15, 2018 · e77f6ee · e77f6ee
1 parent f0f8bd0
commit e77f6ee
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 8 deletions.
diff --git a/src/main/scala/algolia/definitions/IndexSettingsDefinition.scala b/src/main/scala/algolia/definitions/IndexSettingsDefinition.scala
@@ -102,12 +102,19 @@ trait IndexSettingsDsl {
 
   }
 
+  @deprecated("use setSettings", "1.27.1")
   case object changeSettings {
 
     def of(index: String) = IndexSettingsDefinition(index)
 
   }
 
+  case object setSettings {
+
+    def of(index: String) = IndexSettingsDefinition(index)
+
+  }
+
   implicit object IndexSettingsDefinitionExecutable
       extends Executable[IndexSettingsDefinition, IndexSettings] {
     override def apply(client: AlgoliaClient, settings: IndexSettingsDefinition)(

diff --git a/src/test/scala/algolia/dsl/IndexSettingsTest.scala b/src/test/scala/algolia/dsl/IndexSettingsTest.scala
@@ -54,11 +54,11 @@ class IndexSettingsTest extends AlgoliaTest {
 
   }
 
-  describe("change settings") {
+  describe("set settings") {
 
-    it("should get settings") {
-      changeSettings of "index" `with` IndexSettings() and forwardToSlaves
-      changeSettings of "index" `with` IndexSettings() and forwardToReplicas
+    it("should set settings") {
+      setSettings of "index" `with` IndexSettings() and forwardToSlaves
+      setSettings of "index" `with` IndexSettings() and forwardToReplicas
     }
 
     it("should call API") {
@@ -71,7 +71,7 @@ class IndexSettingsTest extends AlgoliaTest {
         requestOptions = None
       )
 
-      (changeSettings of "test" `with` IndexSettings() and forwardToReplicas).build() should be(
+      (setSettings of "test" `with` IndexSettings() and forwardToReplicas).build() should be(
         payload)
     }
 

diff --git a/src/test/scala/algolia/integration/IndexSettingsIntegrationTest.scala b/src/test/scala/algolia/integration/IndexSettingsIntegrationTest.scala
@@ -56,9 +56,9 @@ class IndexSettingsIntegrationTest extends AlgoliaTest {
     }
   }
 
-  it("should update settings") {
+  it("should set settings") {
     val change: Future[Task] = client.execute {
-      changeSettings of "indexToChangeSettings" `with` IndexSettings(
+      setSettings of "indexToChangeSettings" `with` IndexSettings(
         searchableAttributes = Some(Seq(SearchableAttributes.attribute("att")))
       )
     }

diff --git a/src/test/scala/algolia/integration/SearchIntegrationTest.scala b/src/test/scala/algolia/integration/SearchIntegrationTest.scala
@@ -200,7 +200,7 @@ class SearchIntegrationTest extends AlgoliaTest {
 
     it("should search in facets") {
       val change = client.execute {
-        changeSettings of "indexToSearchFacet" `with` IndexSettings(
+        setSettings of "indexToSearchFacet" `with` IndexSettings(
           attributesForFaceting = Some(Seq("searchable(series)"))
         )
       }