Skip to content

Commit 46bd0a2

Browse files
algolia-botshortcuts
algolia-bot
and
shortcuts
committed
docs: fix snippets for helpers (#3529) (generated) [skip ci]
Co-authored-by: Clément Vannicatte <[email protected]>
1 parent ce011e3 commit 46bd0a2

11 files changed

+363
-605
lines changed

‎snippets/guides/abtesting-snippets.json

Lines changed: 33 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,9 @@
3737
"default": "await client.WaitForAppTaskAsync(response.TaskID);"
3838
},
3939
"waitForApiKey": {
40-
"default": {
41-
"add": "await client.WaitForApiKeyAsync(ApiKeyOperation.Add, response.Key);",
42-
"update": "await client.WaitForApiKeyAsync(ApiKeyOperation.Update, response.Key, {\n Acl = new List<Acl> { Enum.Parse<Acl>(\"Search\"), Enum.Parse<Acl>(\"AddObject\") },\n Validity = 300,\n MaxQueriesPerIPPerHour = 100,\n MaxHitsPerQuery = 20,\n });",
43-
"delete": "await client.WaitForApiKeyAsync(ApiKeyOperation.Delete, response.Key);"
44-
}
40+
"add": "await client.WaitForApiKeyAsync(ApiKeyOperation.Add, response.Key);",
41+
"update": "await client.WaitForApiKeyAsync(ApiKeyOperation.Update, response.Key, {\n Acl = new List<Acl> { Enum.Parse<Acl>(\"Search\"), Enum.Parse<Acl>(\"AddObject\") },\n Validity = 300,\n MaxQueriesPerIPPerHour = 100,\n MaxHitsPerQuery = 20,\n });",
42+
"delete": "await client.WaitForApiKeyAsync(ApiKeyOperation.Delete, response.Key);"
4543
},
4644
"waitForTask": {
4745
"default": "await client.WaitForTaskAsync(\"<<indexName>>\", response.TaskID);"
@@ -52,11 +50,9 @@
5250
"default": "await client.waitAppTask(response.taskID);"
5351
},
5452
"waitForApiKey": {
55-
"default": {
56-
"add": "",
57-
"update": "",
58-
"delete": ""
59-
}
53+
"add": "",
54+
"update": "",
55+
"delete": ""
6056
},
6157
"waitForTask": {
6258
"default": "await client.waitTask('<<indexName>>', response.taskID);"
@@ -97,11 +93,9 @@
9793
"default": "taskResponse, err := searchClient.WaitForAppTask(response.TaskID, nil, nil, nil)\nif err != nil {\n panic(err)\n}"
9894
},
9995
"waitForApiKey": {
100-
"default": {
101-
"add": "waitResponse, err := client.WaitForApiKey(search.API_KEY_OPERATION_ADD, response.Key, nil)\nif err != nil {\n panic(err)\n}",
102-
"update": "waitResponse, err := client.WaitForApiKey(search.API_KEY_OPERATION_UPDATE, response.Key, search.NewEmptyApiKey().SetAcl([]search.Acl{search.Acl(\"search\"), search.Acl(\"addObject\")}).SetValidity(300).SetMaxQueriesPerIPPerHour(100).SetMaxHitsPerQuery(20))\nif err != nil {\n panic(err)\n}",
103-
"delete": "waitResponse, err := client.WaitForApiKey(search.API_KEY_OPERATION_DELETE, response.Key, nil)\nif err != nil {\n panic(err)\n}"
104-
}
96+
"add": "waitResponse, err := client.WaitForApiKey(search.API_KEY_OPERATION_ADD, response.Key, nil)\nif err != nil {\n panic(err)\n}",
97+
"update": "waitResponse, err := client.WaitForApiKey(search.API_KEY_OPERATION_UPDATE, response.Key, search.NewEmptyApiKey().SetAcl([]search.Acl{search.Acl(\"search\"), search.Acl(\"addObject\")}).SetValidity(300).SetMaxQueriesPerIPPerHour(100).SetMaxHitsPerQuery(20))\nif err != nil {\n panic(err)\n}",
98+
"delete": "waitResponse, err := client.WaitForApiKey(search.API_KEY_OPERATION_DELETE, response.Key, nil)\nif err != nil {\n panic(err)\n}"
10599
},
106100
"waitForTask": {
107101
"default": "taskResponse, err := searchClient.WaitForTask(\"<<indexName>>\", response.TaskID, nil, nil, nil)\nif err != nil {\n panic(err)\n}"
@@ -145,11 +139,9 @@
145139
"default": "client.waitForAppTask(response.getTaskID());"
146140
},
147141
"waitForApiKey": {
148-
"default": {
149-
"add": "client.waitForApiKey(ApiKeyOperation.ADD, response.Key, null)",
150-
"update": "client.waitForApiKey(ApiKeyOperation.UPDATE, response.Key, new ApiKey()\n .setAcl(List.of(Acl.SEARCH, Acl.ADD_OBJECT))\n .setValidity(300)\n .setMaxQueriesPerIPPerHour(100)\n .setMaxHitsPerQuery(20))",
151-
"delete": "client.waitForApiKey(ApiKeyOperation.DELETE, response.Key, null)"
152-
}
142+
"add": "client.waitForApiKey(ApiKeyOperation.ADD, response.Key, null)",
143+
"update": "client.waitForApiKey(ApiKeyOperation.UPDATE, response.Key, new ApiKey()\n .setAcl(List.of(Acl.SEARCH, Acl.ADD_OBJECT))\n .setValidity(300)\n .setMaxQueriesPerIPPerHour(100)\n .setMaxHitsPerQuery(20))",
144+
"delete": "client.waitForApiKey(ApiKeyOperation.DELETE, response.Key, null)"
153145
},
154146
"waitForTask": {
155147
"default": "client.waitForTask(\"<<indexName>>\", response.getTaskID());"
@@ -193,11 +185,9 @@
193185
"default": "await client.waitForAppTask({ taskID: response.taskID });"
194186
},
195187
"waitForApiKey": {
196-
"default": {
197-
"add": "await client.waitForApiKey({ operation: \"<<operation>>\", key: response.key });",
198-
"update": "await client.waitForApiKey({ operation: \"<<operation>>\", key: response.key, apiKey: {\n acl: ['search', 'addObject'],\n validity: 300,\n maxQueriesPerIPPerHour: 100,\n maxHitsPerQuery: 20,\n }});",
199-
"delete": "await client.waitForApiKey({ operation: \"<<operation>>\", key: response.key });"
200-
}
188+
"add": "await client.waitForApiKey({ operation: \"<<operation>>\", key: response.key });",
189+
"update": "await client.waitForApiKey({ operation: \"<<operation>>\", key: response.key, apiKey: {\n acl: ['search', 'addObject'],\n validity: 300,\n maxQueriesPerIPPerHour: 100,\n maxHitsPerQuery: 20,\n }});",
190+
"delete": "await client.waitForApiKey({ operation: \"<<operation>>\", key: response.key });"
201191
},
202192
"waitForTask": {
203193
"default": "await client.waitForTask({ indexName: '<<indexName>>', taskID: response.taskID });"
@@ -241,11 +231,9 @@
241231
"default": "client.waitAppTask(response.taskID)"
242232
},
243233
"waitForApiKey": {
244-
"default": {
245-
"add": "",
246-
"update": "",
247-
"delete": ""
248-
}
234+
"add": "",
235+
"update": "",
236+
"delete": ""
249237
},
250238
"waitForTask": {
251239
"default": "client.waitTask(\"<<indexName>>\", response.taskID)"
@@ -289,11 +277,9 @@
289277
"default": "$client->waitForAppTask($response['taskID']);"
290278
},
291279
"waitForApiKey": {
292-
"default": {
293-
"add": "$client->waitForApiKey('<<operation>>', $response['key']);",
294-
"update": "$client->waitForApiKey('<<operation>>', $response['key'], [\n 'acl' => [\n 'search',\n 'addObject',\n ],\n 'validity' => 300,\n 'maxQueriesPerIPPerHour' => 100,\n 'maxHitsPerQuery' => 20,\n ]);",
295-
"delete": "$client->waitForApiKey('<<operation>>', $response['key']);"
296-
}
280+
"add": "$client->waitForApiKey('<<operation>>', $response['key']);",
281+
"update": "$client->waitForApiKey('<<operation>>', $response['key'], [\n 'acl' => [\n 'search',\n 'addObject',\n ],\n 'validity' => 300,\n 'maxQueriesPerIPPerHour' => 100,\n 'maxHitsPerQuery' => 20,\n ]);",
282+
"delete": "$client->waitForApiKey('<<operation>>', $response['key']);"
297283
},
298284
"waitForTask": {
299285
"default": "$client->waitForTask('<<indexName>>', $response['taskID']);"
@@ -337,11 +323,9 @@
337323
"default": "await client.wait_for_app_task(task_id=response.task_id)"
338324
},
339325
"waitForApiKey": {
340-
"default": {
341-
"add": "await client.wait_for_api_key(operation=\"<<operation>>\", key=response.key)",
342-
"update": "await client.wait_for_api_key(operation=\"<<operation>>\", key=response.key, api_key={\n \"acl\": [\n \"search\",\n \"addObject\",\n ],\n \"validity\": 300,\n \"maxQueriesPerIPPerHour\": 100,\n \"maxHitsPerQuery\": 20,\n })",
343-
"delete": "await client.wait_for_api_key(operation=\"<<operation>>\", key=response.key)"
344-
}
326+
"add": "await client.wait_for_api_key(operation=\"<<operation>>\", key=response.key)",
327+
"update": "await client.wait_for_api_key(operation=\"<<operation>>\", key=response.key, api_key={\n \"acl\": [\n \"search\",\n \"addObject\",\n ],\n \"validity\": 300,\n \"maxQueriesPerIPPerHour\": 100,\n \"maxHitsPerQuery\": 20,\n })",
328+
"delete": "await client.wait_for_api_key(operation=\"<<operation>>\", key=response.key)"
345329
},
346330
"waitForTask": {
347331
"default": "await client.wait_for_task(index_name=\"<<indexName>>\", task_id=response.task_id)"
@@ -385,11 +369,9 @@
385369
"default": "client.wait_for_app_task(response.task_id)"
386370
},
387371
"waitForApiKey": {
388-
"default": {
389-
"add": "await client.wait_for_api_key(operation=\"<<operation>>\", key=response.key)",
390-
"update": "await client.wait_for_api_key(operation=\"<<operation>>\", key=response.key, api_key=ApiKey.new(\n acl: ['search', 'addObject'],\n validity: 300,\n max_queries_per_ip_per_hour: 100,\n max_hits_per_query: 20\n ))",
391-
"delete": "await client.wait_for_api_key(operation=\"<<operation>>\", key=response.key)"
392-
}
372+
"add": "await client.wait_for_api_key(operation=\"<<operation>>\", key=response.key)",
373+
"update": "await client.wait_for_api_key(operation=\"<<operation>>\", key=response.key, api_key=ApiKey.new(\n acl: ['search', 'addObject'],\n validity: 300,\n max_queries_per_ip_per_hour: 100,\n max_hits_per_query: 20\n ))",
374+
"delete": "await client.wait_for_api_key(operation=\"<<operation>>\", key=response.key)"
393375
},
394376
"waitForTask": {
395377
"default": "client.wait_for_task(\"<<indexName>>\", response.task_id)"
@@ -433,11 +415,9 @@
433415
"default": "client.waitAppTask(response.getTaskID())"
434416
},
435417
"waitForApiKey": {
436-
"default": {
437-
"add": "",
438-
"update": "",
439-
"delete": ""
440-
}
418+
"add": "",
419+
"update": "",
420+
"delete": ""
441421
},
442422
"waitForTask": {
443423
"default": "client.waitTask(\"<<indexName>>\", response.getTaskID())"
@@ -481,11 +461,9 @@
481461
"default": "try await client.waitForAppTask(with: response.taskID)"
482462
},
483463
"waitForApiKey": {
484-
"default": {
485-
"add": "try await client.waitForApiKey(with: response.key, operation: ApiKeyOperation.add)",
486-
"update": "try await client.waitForApiKey(with: response.key, operation: ApiKeyOperation.update, apiKey: ApiKey(\n acl: [Acl.search, Acl.addObject],\n maxHitsPerQuery: 20,\n maxQueriesPerIPPerHour: 100,\n validity: 300\n ))",
487-
"delete": "try await client.waitForApiKey(with: response.key, operation: ApiKeyOperation.delete)"
488-
}
464+
"add": "try await client.waitForApiKey(with: response.key, operation: ApiKeyOperation.add)",
465+
"update": "try await client.waitForApiKey(with: response.key, operation: ApiKeyOperation.update, apiKey: ApiKey(\n acl: [Acl.search, Acl.addObject],\n maxHitsPerQuery: 20,\n maxQueriesPerIPPerHour: 100,\n validity: 300\n ))",
466+
"delete": "try await client.waitForApiKey(with: response.key, operation: ApiKeyOperation.delete)"
489467
},
490468
"waitForTask": {
491469
"default": "try await client.waitForTask(with: response.taskID, in: \"<<indexName>>\")"

0 commit comments

Comments
 (0)