docs(java): small migration guide (#934)

Author: millotp

website/docs/clients/guides/customized-client-usage.mdx

@@ -108,6 +108,7 @@ client.search(
         .setHitsPerPage(50)
     )
   ),
+  MyObject.class,
   new RequestOptions()
     // This header is added to the request
     .addExtraHeader("additional-header", "hello")

website/docs/clients/guides/filtering-your-search.mdx

@@ -154,7 +154,8 @@ client.search(
         .setQuery("<YOUR_QUERY>")
         .setFilters("actor:Scarlett Johansson")
     )
-  )
+  ),
+  Actor.class
 );
 
 // Only "Tom Cruise" or "Scarlett Johansson" actor
@@ -166,7 +167,8 @@ client.search(
         .setQuery("<YOUR_QUERY>")
         .setFilters("actor:Tom Cruise OR actor:Scarlett Johansson")
     )
-  )
+  ),
+  Actor.class
 );
 
 // Everything but "Nicolas Cage" actor
@@ -178,7 +180,8 @@ client.search(
         .setQuery("<YOUR_QUERY>")
         .setFilters("NOT actor:Nicolas Cage")
     )
-  )
+  ),
+  Actor.class
 );
 ```
 
@@ -256,7 +259,8 @@ client.search(
         .setQuery("<YOUR_QUERY>")
         .addFacetFilters("actor:Scarlett Johansson")
     )
-  )
+  ),
+  Actor.class
 );
 
 // Only "Tom Cruise" or "Scarlett Johansson" actor
@@ -269,7 +273,8 @@ client.search(
         .addFacetFilters("actor:Tom Cruise")
         .addFacetFilters("actor:Scarlett Johansson")
     )
-  )
+  ),
+  Actor.class
 );
 ```
 

website/docs/clients/guides/retrieving-facets.mdx

@@ -84,7 +84,8 @@ client.search(
         .addFacets("author")
         .addFacets("genre")
     )
-  )
+  ),
+  MyObject.class
 );
 ```
 
@@ -101,7 +102,8 @@ client.search(
         .setQuery("<YOUR_QUERY>")
         .addFacets("*")
     )
-  )
+  ),
+  MyObject.class
 );
 ```
 

website/docs/clients/guides/send-data-to-algolia.mdx

@@ -122,10 +122,12 @@ $client->waitForTask(<YOUR_INDEX_NAME>, $response['taskID']);
 <TabItem value="java">
 
 ```java
-class Actor {
-  String name;
+import com.algolia.model.search.*;
 
-  Actor(String name) {
+class Actor extends Hit {
+  public String name;
+
+  public Actor(String name) {
     this.name = name;
   }
 }

website/docs/clients/installation.mdx

@@ -178,12 +178,14 @@ client.saveObject("<YOUR_INDEX_NAME>", body);
 SearchMethodParams searchMethodParams = new SearchMethodParams();
 SearchQueries requests = new SearchQueries();
 requests.setIndexName("<YOUR_INDEX_NAME>");
+// Typo tolerant search
 requests.setQuery("my aloglia ojbect");
 searchMethodParams.setRequests(requests);
 
 try {
-  SearchResponse result = client.search(
-    searchMethodParams
+  SearchResponse<MyObject> result = client.search(
+    searchMethodParams,
+    MyObject.class
   );
   System.out.println(result);
 } catch (AlgoliaRuntimeException e) {

website/docs/clients/migration-guides/index.mdx

@@ -93,7 +93,8 @@ client.search(
         .addAttributesToRetrieve("lastname")
         .setHitsPerPage(50)
     )
-  )
+  ),
+  MyObject.class
 );
 ```
 
@@ -153,8 +154,11 @@ const abTest = await abtestingClient.getABTest({
 <TabItem value="java">
 
 ```java
-// TODO
+import com.algolia.api.AbtestingClient;
+import com.algolia.model.abtesting.*;
 
+AbtestingClient client = new AbtestingClient("<YOUR_APP_ID>", "<YOUR_API_KEY>");
+ABTest abTest = client.getABTest(42);
 ```
 
 </TabItem>
@@ -381,10 +385,12 @@ $client->batch(
 <TabItem value="java">
 
 ```java
-class Actor {
-  String name;
+import com.algolia.model.search.*;
+
+class Actor extends Hit {
+  public String name;
 
-  Actor(String name) {
+  public Actor(String name) {
     this.name = name;
   }
 }

website/docs/clients/migration-guides/java.md

@@ -2,4 +2,30 @@
 title: Java
 ---
 
-WIP
+### Methods targeting an `indexName`
+
+Prior to the `initIndex` removal stated in the [common breaking changes](/docs/clients/migration-guides/#common-breaking-changes), all methods previously available at the `initIndex` level requires the `indexName` to be sent with the query.
+
+That also mean you need to explicit the type you want to be returned from your queries, when it applies.
+
+```java
+import com.algolia.api.SearchClient;
+import com.algolia.model.search.*;
+
+SearchClient client = new SearchClient("<YOUR_APP_ID>", "<YOUR_API_KEY>");
+
+client.search(
+  new SearchMethodParams()
+    .addRequests(SearchQuery.of(
+      new SearchForHits()
+        .setIndexName("<YOUR_INDEX_NAME>")
+        .setQuery("<YOUR_QUERY>")
+    )
+  ),
+  MyObject.class
+);
+```
+
+
+
+

website/docs/clients/migration-guides/javascript.md

@@ -3,7 +3,7 @@ title: JavaScript
 ---
 
 | Previous  | Latest         | Description                                                                                                                                                                                                               |
-| --------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+|-----------|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `search`  | `searchClient` | Exported clients are suffixed by `Client`.                                                                                                                                                                                |
 | `destroy` | **removed**    | This method has not been implemented in the new clients, if you feel the need for it, [please open an issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&template=Feature_request.md) |
 

website/docs/clients/migration-guides/php.md

@@ -2,11 +2,11 @@
 title: PHP
 ---
 
-| Previous             | Latest                                 | Description                                                                                                                                                                                                               |
-| -------------------- | :------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `"algolia/algoliasearch-client-php": "^3.2"`           | `"algolia/algoliasearch-client-php": "^4.0@alpha"`  | **During the beta phase**, the clients are available under the package 4.x.x-alpha , you can find a full list [here](https://packagist.org/packages/algolia/algoliasearch-client-php).      |
-| `Algolia\AlgoliaSearch`             | `Algolia\AlgoliaSearch\Api`                         | Exported clients have now the namespace suffixed by `Api`.                                                                                                                                                                                |
-| `Algolia\AlgoliaSearch\Cache\FileCacheDriver`             | **removed**                      |  This implementation of the `CacheInterface` is not available anymore in the Client. If you feel the need for it, [please open an issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&template=Feature_request.md)                                                                                                                                                                              |
+| Previous                                      | Latest                                             | Description                                                                                                                                                                                                                                          |
+|-----------------------------------------------|:---------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `"algolia/algoliasearch-client-php": "^3.2"`  | `"algolia/algoliasearch-client-php": "^4.0@alpha"` | **During the beta phase**, the clients are available under the package 4.x.x-alpha , you can find a full list [here](https://packagist.org/packages/algolia/algoliasearch-client-php).                                                               |
+| `Algolia\AlgoliaSearch`                       | `Algolia\AlgoliaSearch\Api`                        | Exported clients have now the namespace suffixed by `Api`.                                                                                                                                                                                           |
+| `Algolia\AlgoliaSearch\Cache\FileCacheDriver` | **removed**                                        | This implementation of the `CacheInterface` is not available anymore in the Client. If you feel the need for it, [please open an issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&template=Feature_request.md) |
 
 
 ### Usage