guides: add missing snippets to docs (#4391)

shortcuts · Fluf22 · web-flow · commit ad43bfbdacd5 · 2025-01-23T17:08:55.000+01:00
Co-authored-by: Thomas Raffray &lt;Fluf22@users.noreply.github.com&gt;
diff --git a/generators/src/main/java/com/algolia/codegen/cts/tests/Snippet.java b/generators/src/main/java/com/algolia/codegen/cts/tests/Snippet.java
@@ -12,7 +12,6 @@
 public class Snippet {
 
   public String testName;
-  public boolean isSnippet;
 
   public String method;
   public Map<String, Object> parameters;
@@ -21,7 +20,6 @@ public class Snippet {
   public Snippet(String method, String testName, Map<String, Object> parameters) {
     this.method = method;
     this.testName = testName;
-    this.isSnippet = true;
     this.parameters = parameters;
   }
 
@@ -32,7 +30,6 @@ public String toString() {
     StringBuilder sb = new StringBuilder();
     sb.append("class Request {\n");
     sb.append("    testName: ").append(testName).append("\n");
-    sb.append("    isSnippet").append(isSnippet).append("\n");
     sb.append("    method: ").append(method).append("\n");
     sb.append("    parameters: ").append(parameters).append("\n");
     sb.append("    requestOptions: ").append(requestOptions).append("\n");
diff --git a/generators/src/main/java/com/algolia/codegen/cts/tests/SnippetsGenerator.java b/generators/src/main/java/com/algolia/codegen/cts/tests/SnippetsGenerator.java
@@ -101,12 +101,7 @@ public void run(Map<String, CodegenModel> models, Map<String, CodegenOperation>
         continue;
       }
 
-      List<Snippet> ops = Arrays.stream(snippets.get(operationId)).filter(r -> r.isSnippet).toList();
-      if (ops.size() == 0) {
-        // default to the first test
-        ops = List.of(snippets.get(operationId)[0]);
-      }
-
+      List<Snippet> ops = Arrays.stream(snippets.get(operationId)).toList();
       List<Map<String, Object>> tests = new ArrayList<>();
 
       for (int i = 0; i < ops.size(); i++) {
diff --git a/templates/csharp/snippets/import.mustache b/templates/csharp/snippets/import.mustache
@@ -1,2 +1,3 @@
 using Algolia.Search.Clients;
+using Algolia.Search.Http;
 using Algolia.Search.Models.{{clientPrefix}};
diff --git a/templates/java/snippets/import.mustache b/templates/java/snippets/import.mustache
@@ -1,2 +1,3 @@
 import com.algolia.api.{{client}};
-import com.algolia.model.{{import}}.*;
+import com.algolia.model.{{import}}.*;
+import com.algolia.config.*;
diff --git a/templates/kotlin/snippets/import.mustache b/templates/kotlin/snippets/import.mustache
@@ -1,4 +1,9 @@
 import com.algolia.client.api.{{client}}
+import com.algolia.client.configuration.*
+import com.algolia.client.transport.*
 {{#isSearchClient}}
 import com.algolia.client.extensions.*
-{{/isSearchClient}}
+{{/isSearchClient}}
+{{#isCompositionClient}}
+import com.algolia.client.model.{{import}}.RequestBody
+{{/isCompositionClient}}
diff --git a/templates/python/partial_api_args.mustache b/templates/python/partial_api_args.mustache
@@ -1,7 +1,7 @@
 (
         self,
         {{#allParams}}
-        {{paramName}}: {{#isModel}}Union[{{/isModel}}{{#isArray}}{{#items.isModel}}Union[{{/items.isModel}}{{/isArray}}{{#isEnumRef}}Union[{{/isEnumRef}}{{{vendorExtensions.x-py-typing}}}{{#isModel}}, dict[str, Any]]{{/isModel}}{{#isEnumRef}}, str]{{/isEnumRef}}{{#isArray}}{{#items.isModel}}, list[dict[str, Any]]]{{/items.isModel}}{{/isArray}}{{^required}} = None{{/required}},
+        {{paramName}}: {{#isModel}}Union[{{/isModel}}{{#isArray}}{{#items.isEnumRef}}Union[list[str], {{/items.isEnumRef}}{{#items.isModel}}Union[{{/items.isModel}}{{/isArray}}{{#isEnumRef}}Union[{{/isEnumRef}}{{{vendorExtensions.x-py-typing}}}{{#isModel}}, dict[str, Any]]{{/isModel}}{{#isEnumRef}}, str]{{/isEnumRef}}{{#isArray}}{{#items.isEnumRef}}]{{/items.isEnumRef}}{{#items.isModel}}, {{#isQueryParam}}list[str], {{/isQueryParam}} list[dict[str, Any]]]{{/items.isModel}}{{/isArray}}{{^required}} = None{{/required}},
         {{/allParams}}
         request_options: Optional[Union[dict, RequestOptions]] = None
     )
diff --git a/templates/python/snippets/import.mustache b/templates/python/snippets/import.mustache
@@ -1,2 +1,3 @@
 from algoliasearch.{{{import}}}.client import {{#lambda.pascalcase}}{{{client}}}{{/lambda.pascalcase}}
-from algoliasearch.{{{import}}}.client import {{#lambda.pascalcase}}{{{client}}}Sync{{/lambda.pascalcase}}
+from algoliasearch.{{{import}}}.client import {{#lambda.pascalcase}}{{{client}}}Sync{{/lambda.pascalcase}}
+from json import loads
diff --git a/templates/scala/snippets/import.mustache b/templates/scala/snippets/import.mustache
@@ -1,4 +1,5 @@
 import algoliasearch.api.{{client}}
+import algoliasearch.config.*
 {{#isSearchClient}}
 import algoliasearch.extension.SearchClientExtensions
 {{/isSearchClient}}
diff --git a/tests/CTS/requests/ingestion/listAuthentications.json b/tests/CTS/requests/ingestion/listAuthentications.json
@@ -16,9 +16,7 @@
         "basic",
         "algolia"
       ],
-      "platform": [
-        "none"
-      ],
+      "platform": ["none"],
       "sort": "createdAt",
       "order": "asc"
     },
diff --git a/tests/CTS/requests/search/batch.json b/tests/CTS/requests/search/batch.json
@@ -1,7 +1,6 @@
 [
   {
     "testName": "addObject",
-    "isSnippet": true,
     "parameters": {
       "indexName": "<YOUR_INDEX_NAME>",
       "batchWriteParams": {
@@ -48,7 +47,6 @@
   },
   {
     "testName": "clear",
-    "isSnippet": true,
     "parameters": {
       "indexName": "<YOUR_INDEX_NAME>",
       "batchWriteParams": {
@@ -79,7 +77,6 @@
   },
   {
     "testName": "delete",
-    "isSnippet": true,
     "parameters": {
       "indexName": "<YOUR_INDEX_NAME>",
       "batchWriteParams": {
@@ -110,7 +107,6 @@
   },
   {
     "testName": "deleteObject",
-    "isSnippet": true,
     "parameters": {
       "indexName": "<YOUR_INDEX_NAME>",
       "batchWriteParams": {
@@ -141,7 +137,6 @@
   },
   {
     "testName": "partialUpdateObject",
-    "isSnippet": true,
     "parameters": {
       "indexName": "<YOUR_INDEX_NAME>",
       "batchWriteParams": {
@@ -172,7 +167,6 @@
   },
   {
     "testName": "partialUpdateObjectNoCreate",
-    "isSnippet": true,
     "parameters": {
       "indexName": "<YOUR_INDEX_NAME>",
       "batchWriteParams": {
@@ -203,7 +197,6 @@
   },
   {
     "testName": "updateObject",
-    "isSnippet": true,
     "parameters": {
       "indexName": "<YOUR_INDEX_NAME>",
       "batchWriteParams": {
diff --git a/tests/CTS/requests/search/batchDictionaryEntries.json b/tests/CTS/requests/search/batchDictionaryEntries.json
@@ -1,7 +1,6 @@
 [
   {
     "testName": "replace",
-    "isSnippet": true,
     "parameters": {
       "dictionaryName": "plurals",
       "batchDictionaryEntriesParams": {
@@ -56,7 +55,6 @@
   },
   {
     "testName": "delete",
-    "isSnippet": true,
     "parameters": {
       "dictionaryName": "plurals",
       "batchDictionaryEntriesParams": {
@@ -89,7 +87,6 @@
   },
   {
     "testName": "append",
-    "isSnippet": true,
     "parameters": {
       "dictionaryName": "stopwords",
       "batchDictionaryEntriesParams": {
diff --git a/tests/CTS/requests/search/listIndices.json b/tests/CTS/requests/search/listIndices.json
@@ -1,7 +1,6 @@
 [
   {
     "testName": "listIndices with minimal parameters",
-    "isSnippet": true,
     "parameters": {},
     "request": {
       "path": "/1/indexes",
diff --git a/tests/CTS/requests/search/operationIndex.json b/tests/CTS/requests/search/operationIndex.json
@@ -1,7 +1,6 @@
 [
   {
     "testName": "scopes",
-    "isSnippet": true,
     "parameters": {
       "indexName": "<SOURCE_INDEX_NAME>",
       "operationIndexParams": {
@@ -28,7 +27,6 @@
   },
   {
     "testName": "copy",
-    "isSnippet": true,
     "parameters": {
       "indexName": "<SOURCE_INDEX_NAME>",
       "operationIndexParams": {
@@ -47,7 +45,6 @@
   },
   {
     "testName": "move",
-    "isSnippet": true,
     "parameters": {
       "indexName": "<SOURCE_INDEX_NAME>",
       "operationIndexParams": {
diff --git a/tests/CTS/requests/search/partialUpdateObject.json b/tests/CTS/requests/search/partialUpdateObject.json
@@ -77,7 +77,6 @@
   },
   {
     "testName": "Partial update with a new value for an object attribute",
-    "isSnippet": true,
     "parameters": {
       "indexName": "theIndexName",
       "objectID": "uniqueID",
@@ -99,7 +98,6 @@
   },
   {
     "testName": "with visible_by filter",
-    "isSnippet": true,
     "parameters": {
       "indexName": "theIndexName",
       "objectID": "uniqueID",
diff --git a/tests/CTS/requests/search/saveRule.json b/tests/CTS/requests/search/saveRule.json
@@ -181,7 +181,6 @@
   },
   {
     "testName": "b2b catalog",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "article-rule",
@@ -233,7 +232,6 @@
   },
   {
     "testName": "merchandising and promoting",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "director-rule",
@@ -291,7 +289,6 @@
   },
   {
     "testName": "harry potter",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "harry-potter-rule",
@@ -331,7 +328,6 @@
   },
   {
     "testName": "merchandising empty query",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "clearance-category-filter",
@@ -373,7 +369,6 @@
   },
   {
     "testName": "redirect",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "redirect-help-rule",
@@ -413,7 +408,6 @@
   },
   {
     "testName": "promote some results over others",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "tomato-fruit",
@@ -449,7 +443,6 @@
   },
   {
     "testName": "promote several hits",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "Promote-Apple-Newest",
@@ -491,7 +484,6 @@
   },
   {
     "testName": "promote newest release",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "Promote-iPhone-X",
@@ -533,7 +525,6 @@
   },
   {
     "testName": "promote single item",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "promote-harry-potter-box-set",
@@ -573,7 +564,6 @@
   },
   {
     "testName": "limit search results",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "article-rule",
@@ -621,7 +611,6 @@
   },
   {
     "testName": "query match",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "tagged-brand-rule",
@@ -671,7 +660,6 @@
   },
   {
     "testName": "dynamic filtering",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "color-facets",
@@ -709,7 +697,6 @@
   },
   {
     "testName": "hide hits",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "hide-12345",
@@ -745,7 +732,6 @@
   },
   {
     "testName": "one rule per facet",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "red-color",
@@ -787,7 +773,6 @@
   },
   {
     "testName": "numerical filters",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "cheap",
@@ -829,7 +814,6 @@
   },
   {
     "testName": "negative filters",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "gluten-free-rule",
@@ -881,7 +865,6 @@
   },
   {
     "testName": "positive filters",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "diet-rule",
@@ -933,7 +916,6 @@
   },
   {
     "testName": "conditionless",
-    "isSnippet": true,
     "parameters": {
       "indexName": "indexName",
       "objectID": "diet-rule",
diff --git a/tests/CTS/requests/search/search.json b/tests/CTS/requests/search/search.json
diff --git a/tests/CTS/requests/search/searchForFacetValues.json b/tests/CTS/requests/search/searchForFacetValues.json
diff --git a/tests/CTS/requests/search/searchSingleIndex.json b/tests/CTS/requests/search/searchSingleIndex.json
diff --git a/tests/CTS/requests/search/setSettings.json b/tests/CTS/requests/search/setSettings.json
diff --git a/tests/output/javascript/yarn.lock b/tests/output/javascript/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`using Algolia.Search.Clients;`
	`2`	`+using Algolia.Search.Http;`
`2`	`3`	`using Algolia.Search.Models.{{clientPrefix}};`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`(`
`2`	`2`	`self,`
`3`	`3`	`{{#allParams}}`
`4`		`- {{paramName}}: {{#isModel}}Union[{{/isModel}}{{#isArray}}{{#items.isModel}}Union[{{/items.isModel}}{{/isArray}}{{#isEnumRef}}Union[{{/isEnumRef}}{{{vendorExtensions.x-py-typing}}}{{#isModel}}, dict[str, Any]]{{/isModel}}{{#isEnumRef}}, str]{{/isEnumRef}}{{#isArray}}{{#items.isModel}}, list[dict[str, Any]]]{{/items.isModel}}{{/isArray}}{{^required}} = None{{/required}},`
	`4`	+ {{paramName}}: {{#isModel}}Union[{{/isModel}}{{#isArray}}{{#items.isEnumRef}}Union[list[str], {{/items.isEnumRef}}{{#items.isModel}}Union[{{/items.isModel}}{{/isArray}}{{#isEnumRef}}Union[{{/isEnumRef}}{{{vendorExtensions.x-py-typing}}}{{#isModel}}, dict[str, Any]]{{/isModel}}{{#isEnumRef}}, str]{{/isEnumRef}}{{#isArray}}{{#items.isEnumRef}}]{{/items.isEnumRef}}{{#items.isModel}}, {{#isQueryParam}}list[str], {{/isQueryParam}} list[dict[str, Any]]]{{/items.isModel}}{{/isArray}}{{^required}} = None{{/required}},
`5`	`5`	`{{/allParams}}`
`6`	`6`	`request_options: Optional[Union[dict, RequestOptions]] = None`
`7`	`7`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"testName": "replace",`
`4`		`- "isSnippet": true,`
`5`	`4`	`"parameters": {`
`6`	`5`	`"dictionaryName": "plurals",`
`7`	`6`	`"batchDictionaryEntriesParams": {`
`@@ -56,7 +55,6 @@`
`56`	`55`	`},`
`57`	`56`	`{`
`58`	`57`	`"testName": "delete",`
`59`		`- "isSnippet": true,`
`60`	`58`	`"parameters": {`
`61`	`59`	`"dictionaryName": "plurals",`
`62`	`60`	`"batchDictionaryEntriesParams": {`
`@@ -89,7 +87,6 @@`
`89`	`87`	`},`
`90`	`88`	`{`
`91`	`89`	`"testName": "append",`
`92`		`- "isSnippet": true,`
`93`	`90`	`"parameters": {`
`94`	`91`	`"dictionaryName": "stopwords",`
`95`	`92`	`"batchDictionaryEntriesParams": {`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"testName": "listIndices with minimal parameters",`
`4`		`- "isSnippet": true,`
`5`	`4`	`"parameters": {},`
`6`	`5`	`"request": {`
`7`	`6`	`"path": "/1/indexes",`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"testName": "scopes",`
`4`		`- "isSnippet": true,`
`5`	`4`	`"parameters": {`
`6`	`5`	`"indexName": "<SOURCE_INDEX_NAME>",`
`7`	`6`	`"operationIndexParams": {`
`@@ -28,7 +27,6 @@`
`28`	`27`	`},`
`29`	`28`	`{`
`30`	`29`	`"testName": "copy",`
`31`		`- "isSnippet": true,`
`32`	`30`	`"parameters": {`
`33`	`31`	`"indexName": "<SOURCE_INDEX_NAME>",`
`34`	`32`	`"operationIndexParams": {`
`@@ -47,7 +45,6 @@`
`47`	`45`	`},`
`48`	`46`	`{`
`49`	`47`	`"testName": "move",`
`50`		`- "isSnippet": true,`
`51`	`48`	`"parameters": {`
`52`	`49`	`"indexName": "<SOURCE_INDEX_NAME>",`
`53`	`50`	`"operationIndexParams": {`