Skip to content

Commit ad43bfb

Browse files
shortcutsFluf22
andauthored
guides: add missing snippets to docs (#4391)
Co-authored-by: Thomas Raffray <[email protected]>
1 parent 1116113 commit ad43bfb

File tree

20 files changed

+453
-428
lines changed

20 files changed

+453
-428
lines changed

generators/src/main/java/com/algolia/codegen/cts/tests/Snippet.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
public class Snippet {
1313

1414
public String testName;
15-
public boolean isSnippet;
1615

1716
public String method;
1817
public Map<String, Object> parameters;
@@ -21,7 +20,6 @@ public class Snippet {
2120
public Snippet(String method, String testName, Map<String, Object> parameters) {
2221
this.method = method;
2322
this.testName = testName;
24-
this.isSnippet = true;
2523
this.parameters = parameters;
2624
}
2725

@@ -32,7 +30,6 @@ public String toString() {
3230
StringBuilder sb = new StringBuilder();
3331
sb.append("class Request {\n");
3432
sb.append(" testName: ").append(testName).append("\n");
35-
sb.append(" isSnippet").append(isSnippet).append("\n");
3633
sb.append(" method: ").append(method).append("\n");
3734
sb.append(" parameters: ").append(parameters).append("\n");
3835
sb.append(" requestOptions: ").append(requestOptions).append("\n");

generators/src/main/java/com/algolia/codegen/cts/tests/SnippetsGenerator.java

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -101,12 +101,7 @@ public void run(Map<String, CodegenModel> models, Map<String, CodegenOperation>
101101
continue;
102102
}
103103

104-
List<Snippet> ops = Arrays.stream(snippets.get(operationId)).filter(r -> r.isSnippet).toList();
105-
if (ops.size() == 0) {
106-
// default to the first test
107-
ops = List.of(snippets.get(operationId)[0]);
108-
}
109-
104+
List<Snippet> ops = Arrays.stream(snippets.get(operationId)).toList();
110105
List<Map<String, Object>> tests = new ArrayList<>();
111106

112107
for (int i = 0; i < ops.size(); i++) {
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
using Algolia.Search.Clients;
2+
using Algolia.Search.Http;
23
using Algolia.Search.Models.{{clientPrefix}};
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
import com.algolia.api.{{client}};
2-
import com.algolia.model.{{import}}.*;
2+
import com.algolia.model.{{import}}.*;
3+
import com.algolia.config.*;
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
import com.algolia.client.api.{{client}}
2+
import com.algolia.client.configuration.*
3+
import com.algolia.client.transport.*
24
{{#isSearchClient}}
35
import com.algolia.client.extensions.*
4-
{{/isSearchClient}}
6+
{{/isSearchClient}}
7+
{{#isCompositionClient}}
8+
import com.algolia.client.model.{{import}}.RequestBody
9+
{{/isCompositionClient}}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
(
22
self,
33
{{#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}},
55
{{/allParams}}
66
request_options: Optional[Union[dict, RequestOptions]] = None
77
)
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
from algoliasearch.{{{import}}}.client import {{#lambda.pascalcase}}{{{client}}}{{/lambda.pascalcase}}
2-
from algoliasearch.{{{import}}}.client import {{#lambda.pascalcase}}{{{client}}}Sync{{/lambda.pascalcase}}
2+
from algoliasearch.{{{import}}}.client import {{#lambda.pascalcase}}{{{client}}}Sync{{/lambda.pascalcase}}
3+
from json import loads
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import algoliasearch.api.{{client}}
2+
import algoliasearch.config.*
23
{{#isSearchClient}}
34
import algoliasearch.extension.SearchClientExtensions
45
{{/isSearchClient}}

tests/CTS/requests/ingestion/listAuthentications.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@
1616
"basic",
1717
"algolia"
1818
],
19-
"platform": [
20-
"none"
21-
],
19+
"platform": ["none"],
2220
"sort": "createdAt",
2321
"order": "asc"
2422
},

tests/CTS/requests/search/batch.json

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
[
22
{
33
"testName": "addObject",
4-
"isSnippet": true,
54
"parameters": {
65
"indexName": "<YOUR_INDEX_NAME>",
76
"batchWriteParams": {
@@ -48,7 +47,6 @@
4847
},
4948
{
5049
"testName": "clear",
51-
"isSnippet": true,
5250
"parameters": {
5351
"indexName": "<YOUR_INDEX_NAME>",
5452
"batchWriteParams": {
@@ -79,7 +77,6 @@
7977
},
8078
{
8179
"testName": "delete",
82-
"isSnippet": true,
8380
"parameters": {
8481
"indexName": "<YOUR_INDEX_NAME>",
8582
"batchWriteParams": {
@@ -110,7 +107,6 @@
110107
},
111108
{
112109
"testName": "deleteObject",
113-
"isSnippet": true,
114110
"parameters": {
115111
"indexName": "<YOUR_INDEX_NAME>",
116112
"batchWriteParams": {
@@ -141,7 +137,6 @@
141137
},
142138
{
143139
"testName": "partialUpdateObject",
144-
"isSnippet": true,
145140
"parameters": {
146141
"indexName": "<YOUR_INDEX_NAME>",
147142
"batchWriteParams": {
@@ -172,7 +167,6 @@
172167
},
173168
{
174169
"testName": "partialUpdateObjectNoCreate",
175-
"isSnippet": true,
176170
"parameters": {
177171
"indexName": "<YOUR_INDEX_NAME>",
178172
"batchWriteParams": {
@@ -203,7 +197,6 @@
203197
},
204198
{
205199
"testName": "updateObject",
206-
"isSnippet": true,
207200
"parameters": {
208201
"indexName": "<YOUR_INDEX_NAME>",
209202
"batchWriteParams": {

0 commit comments

Comments
 (0)