Skip to content

Commit b54c454

Browse files
algolia-botshortcutsmorganleroimillotpFluf22
committed
docs: lot of guides (#4355) (generated) [skip ci]
Co-authored-by: Clément Vannicatte <[email protected]> Co-authored-by: Morgan Leroi <[email protected]> Co-authored-by: Pierre Millot <[email protected]> Co-authored-by: Thomas Raffray <[email protected]>
1 parent eb83e3b commit b54c454

File tree

105 files changed

+70945
-14896
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+70945
-14896
lines changed

‎clients/algoliasearch-client-go/algolia/search/api_search.go‎

Lines changed: 7 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/SearchClient.java‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7022,7 +7022,10 @@ public <T> ReplaceAllObjectsResponse replaceAllObjects(
70227022
public String generateSecuredApiKey(@Nonnull String parentApiKey, @Nonnull SecuredApiKeyRestrictions restrictions) throws Exception {
70237023
Map<String, String> restrictionsMap = new HashMap<>();
70247024
if (restrictions.getFilters() != null) restrictionsMap.put("filters", StringUtils.paramToString(restrictions.getFilters()));
7025-
if (restrictions.getValidUntil() != 0) restrictionsMap.put("validUntil", StringUtils.paramToString(restrictions.getValidUntil()));
7025+
if (restrictions.getValidUntil() != null && restrictions.getValidUntil() != 0) restrictionsMap.put(
7026+
"validUntil",
7027+
StringUtils.paramToString(restrictions.getValidUntil())
7028+
);
70267029
if (restrictions.getRestrictIndices() != null) restrictionsMap.put(
70277030
"restrictIndices",
70287031
StringUtils.paramToString(restrictions.getRestrictIndices())

‎docs/bundled/abtesting-snippets.json‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,40 +49,40 @@
4949
"default": "import \"github.com/algolia/algoliasearch-client-go/v4/algolia/abtesting\""
5050
},
5151
"addABTests": {
52-
"default": "response, err := client.AddABTests(client.NewApiAddABTestsRequest(\n\n abtesting.NewEmptyAddABTestsRequest().SetEndAt(\"2022-12-31T00:00:00.000Z\").SetName(\"myABTest\").SetVariants(\n []abtesting.AddABTestsVariant{*abtesting.AbTestsVariantAsAddABTestsVariant(\n abtesting.NewEmptyAbTestsVariant().SetIndex(\"AB_TEST_1\").SetTrafficPercentage(30)), *abtesting.AbTestsVariantAsAddABTestsVariant(\n abtesting.NewEmptyAbTestsVariant().SetIndex(\"AB_TEST_2\").SetTrafficPercentage(50))}),\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
52+
"default": "response, err := client.AddABTests(client.NewApiAddABTestsRequest(\n\n abtesting.NewEmptyAddABTestsRequest().SetEndAt(\"2022-12-31T00:00:00.000Z\").SetName(\"myABTest\").SetVariants(\n []abtesting.AddABTestsVariant{*abtesting.AbTestsVariantAsAddABTestsVariant(\n abtesting.NewEmptyAbTestsVariant().SetIndex(\"AB_TEST_1\").SetTrafficPercentage(30)), *abtesting.AbTestsVariantAsAddABTestsVariant(\n abtesting.NewEmptyAbTestsVariant().SetIndex(\"AB_TEST_2\").SetTrafficPercentage(50))})))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
5353
},
5454
"customDelete": {
55-
"default": "response, err := client.CustomDelete(client.NewApiCustomDeleteRequest(\n \"test/minimal\",\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
55+
"default": "response, err := client.CustomDelete(client.NewApiCustomDeleteRequest(\n \"test/minimal\"))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
5656
},
5757
"customGet": {
58-
"default": "response, err := client.CustomGet(client.NewApiCustomGetRequest(\n \"test/minimal\",\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
58+
"default": "response, err := client.CustomGet(client.NewApiCustomGetRequest(\n \"test/minimal\"))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
5959
},
6060
"customPost": {
61-
"default": "response, err := client.CustomPost(client.NewApiCustomPostRequest(\n \"test/minimal\",\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
61+
"default": "response, err := client.CustomPost(client.NewApiCustomPostRequest(\n \"test/minimal\"))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
6262
},
6363
"customPut": {
64-
"default": "response, err := client.CustomPut(client.NewApiCustomPutRequest(\n \"test/minimal\",\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
64+
"default": "response, err := client.CustomPut(client.NewApiCustomPutRequest(\n \"test/minimal\"))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
6565
},
6666
"deleteABTest": {
67-
"default": "response, err := client.DeleteABTest(client.NewApiDeleteABTestRequest(\n 42,\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
67+
"default": "response, err := client.DeleteABTest(client.NewApiDeleteABTestRequest(\n 42))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
6868
},
6969
"estimateABTest": {
70-
"default": "response, err := client.EstimateABTest(client.NewApiEstimateABTestRequest(\n\n abtesting.NewEmptyEstimateABTestRequest().SetConfiguration(\n abtesting.NewEmptyEstimateConfiguration().SetEmptySearch(\n abtesting.NewEmptyEmptySearch().SetExclude(true)).SetMinimumDetectableEffect(\n abtesting.NewEmptyMinimumDetectableEffect().SetSize(0.03).SetMetric(abtesting.EffectMetric(\"conversionRate\")))).SetVariants(\n []abtesting.AddABTestsVariant{*abtesting.AbTestsVariantAsAddABTestsVariant(\n abtesting.NewEmptyAbTestsVariant().SetIndex(\"AB_TEST_1\").SetTrafficPercentage(50)), *abtesting.AbTestsVariantAsAddABTestsVariant(\n abtesting.NewEmptyAbTestsVariant().SetIndex(\"AB_TEST_2\").SetTrafficPercentage(50))}),\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
70+
"default": "response, err := client.EstimateABTest(client.NewApiEstimateABTestRequest(\n\n abtesting.NewEmptyEstimateABTestRequest().SetConfiguration(\n abtesting.NewEmptyEstimateConfiguration().SetEmptySearch(\n abtesting.NewEmptyEmptySearch().SetExclude(true)).SetMinimumDetectableEffect(\n abtesting.NewEmptyMinimumDetectableEffect().SetSize(0.03).SetMetric(abtesting.EffectMetric(\"conversionRate\")))).SetVariants(\n []abtesting.AddABTestsVariant{*abtesting.AbTestsVariantAsAddABTestsVariant(\n abtesting.NewEmptyAbTestsVariant().SetIndex(\"AB_TEST_1\").SetTrafficPercentage(50)), *abtesting.AbTestsVariantAsAddABTestsVariant(\n abtesting.NewEmptyAbTestsVariant().SetIndex(\"AB_TEST_2\").SetTrafficPercentage(50))})))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
7171
},
7272
"getABTest": {
73-
"default": "response, err := client.GetABTest(client.NewApiGetABTestRequest(\n 42,\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
73+
"default": "response, err := client.GetABTest(client.NewApiGetABTestRequest(\n 42))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
7474
},
7575
"listABTests": {
7676
"default": "response, err := client.ListABTests(client.NewApiListABTestsRequest())\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
7777
},
7878
"scheduleABTest": {
79-
"default": "response, err := client.ScheduleABTest(client.NewApiScheduleABTestRequest(\n\n abtesting.NewEmptyScheduleABTestsRequest().SetEndAt(\"2022-12-31T00:00:00.000Z\").SetScheduledAt(\"2022-11-31T00:00:00.000Z\").SetName(\"myABTest\").SetVariants(\n []abtesting.AddABTestsVariant{*abtesting.AbTestsVariantAsAddABTestsVariant(\n abtesting.NewEmptyAbTestsVariant().SetIndex(\"AB_TEST_1\").SetTrafficPercentage(30)), *abtesting.AbTestsVariantAsAddABTestsVariant(\n abtesting.NewEmptyAbTestsVariant().SetIndex(\"AB_TEST_2\").SetTrafficPercentage(50))}),\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
79+
"default": "response, err := client.ScheduleABTest(client.NewApiScheduleABTestRequest(\n\n abtesting.NewEmptyScheduleABTestsRequest().SetEndAt(\"2022-12-31T00:00:00.000Z\").SetScheduledAt(\"2022-11-31T00:00:00.000Z\").SetName(\"myABTest\").SetVariants(\n []abtesting.AddABTestsVariant{*abtesting.AbTestsVariantAsAddABTestsVariant(\n abtesting.NewEmptyAbTestsVariant().SetIndex(\"AB_TEST_1\").SetTrafficPercentage(30)), *abtesting.AbTestsVariantAsAddABTestsVariant(\n abtesting.NewEmptyAbTestsVariant().SetIndex(\"AB_TEST_2\").SetTrafficPercentage(50))})))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
8080
},
8181
"setClientApiKey": {
82-
"default": "err = client.SetClientApiKey(\n \"updated-api-key\",\n)\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
82+
"default": "err = client.SetClientApiKey(\n \"updated-api-key\")\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
8383
},
8484
"stopABTest": {
85-
"default": "response, err := client.StopABTest(client.NewApiStopABTestRequest(\n 42,\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
85+
"default": "response, err := client.StopABTest(client.NewApiStopABTestRequest(\n 42))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
8686
},
8787
"init": {
8888
"default": "client, err := abtesting.NewClient(\"ALGOLIA_APPLICATION_ID\", \"ALGOLIA_API_KEY\", abtesting.US)\nif err != nil {\n // The client can fail to initialize if you pass an invalid parameter.\n panic(err)\n}"

‎docs/bundled/abtesting.yml‎

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -167,9 +167,7 @@ paths:
167167
// Call the API
168168
169169
response, err := client.CustomGet(client.NewApiCustomGetRequest(
170-
"test/minimal",
171-
))
172-
170+
"test/minimal"))
173171
if err != nil {
174172
// handle the eventual error
175173
panic(err)
@@ -398,9 +396,7 @@ paths:
398396
// Call the API
399397
400398
response, err := client.CustomPost(client.NewApiCustomPostRequest(
401-
"test/minimal",
402-
))
403-
399+
"test/minimal"))
404400
if err != nil {
405401
// handle the eventual error
406402
panic(err)
@@ -629,9 +625,7 @@ paths:
629625
// Call the API
630626
631627
response, err := client.CustomPut(client.NewApiCustomPutRequest(
632-
"test/minimal",
633-
))
634-
628+
"test/minimal"))
635629
if err != nil {
636630
// handle the eventual error
637631
panic(err)
@@ -855,9 +849,7 @@ paths:
855849
856850
response, err :=
857851
client.CustomDelete(client.NewApiCustomDeleteRequest(
858-
"test/minimal",
859-
))
860-
852+
"test/minimal"))
861853
if err != nil {
862854
// handle the eventual error
863855
panic(err)
@@ -1129,9 +1121,7 @@ paths:
11291121
abtesting.NewEmptyAddABTestsRequest().SetEndAt("2022-12-31T00:00:00.000Z").SetName("myABTest").SetVariants(
11301122
[]abtesting.AddABTestsVariant{*abtesting.AbTestsVariantAsAddABTestsVariant(
11311123
abtesting.NewEmptyAbTestsVariant().SetIndex("AB_TEST_1").SetTrafficPercentage(30)), *abtesting.AbTestsVariantAsAddABTestsVariant(
1132-
abtesting.NewEmptyAbTestsVariant().SetIndex("AB_TEST_2").SetTrafficPercentage(50))}),
1133-
))
1134-
1124+
abtesting.NewEmptyAbTestsVariant().SetIndex("AB_TEST_2").SetTrafficPercentage(50))})))
11351125
if err != nil {
11361126
// handle the eventual error
11371127
panic(err)
@@ -1743,9 +1733,7 @@ paths:
17431733
// Call the API
17441734
17451735
response, err := client.GetABTest(client.NewApiGetABTestRequest(
1746-
42,
1747-
))
1748-
1736+
42))
17491737
if err != nil {
17501738
// handle the eventual error
17511739
panic(err)
@@ -2014,9 +2002,7 @@ paths:
20142002
// Call the API
20152003
20162004
response, err := client.StopABTest(client.NewApiStopABTestRequest(
2017-
42,
2018-
))
2019-
2005+
42))
20202006
if err != nil {
20212007
// handle the eventual error
20222008
panic(err)
@@ -2293,9 +2279,7 @@ paths:
22932279
abtesting.NewEmptyScheduleABTestsRequest().SetEndAt("2022-12-31T00:00:00.000Z").SetScheduledAt("2022-11-31T00:00:00.000Z").SetName("myABTest").SetVariants(
22942280
[]abtesting.AddABTestsVariant{*abtesting.AbTestsVariantAsAddABTestsVariant(
22952281
abtesting.NewEmptyAbTestsVariant().SetIndex("AB_TEST_1").SetTrafficPercentage(30)), *abtesting.AbTestsVariantAsAddABTestsVariant(
2296-
abtesting.NewEmptyAbTestsVariant().SetIndex("AB_TEST_2").SetTrafficPercentage(50))}),
2297-
))
2298-
2282+
abtesting.NewEmptyAbTestsVariant().SetIndex("AB_TEST_2").SetTrafficPercentage(50))})))
22992283
if err != nil {
23002284
// handle the eventual error
23012285
panic(err)
@@ -2693,9 +2677,7 @@ paths:
26932677
abtesting.NewEmptyMinimumDetectableEffect().SetSize(0.03).SetMetric(abtesting.EffectMetric("conversionRate")))).SetVariants(
26942678
[]abtesting.AddABTestsVariant{*abtesting.AbTestsVariantAsAddABTestsVariant(
26952679
abtesting.NewEmptyAbTestsVariant().SetIndex("AB_TEST_1").SetTrafficPercentage(50)), *abtesting.AbTestsVariantAsAddABTestsVariant(
2696-
abtesting.NewEmptyAbTestsVariant().SetIndex("AB_TEST_2").SetTrafficPercentage(50))}),
2697-
))
2698-
2680+
abtesting.NewEmptyAbTestsVariant().SetIndex("AB_TEST_2").SetTrafficPercentage(50))})))
26992681
if err != nil {
27002682
// handle the eventual error
27012683
panic(err)

0 commit comments

Comments
 (0)