Merge branch 'main' into feat/helper-tests

Author: millotp

.github/workflows/check.yml

@@ -420,6 +420,29 @@ jobs:
         with:
           type: minimal
 
+      - name: Generate documentation specs with code snippets
+        if: ${{ needs.setup.outputs.RUN_GEN == 'true' || needs.setup.outputs.RUN_GEN_JAVASCRIPT == 'true' }}
+        run: yarn cli build specs ${{ fromJSON(needs.setup.outputs.SPECS_MATRIX).toRun }} --docs
+
+      - name: Build website
+        run: yarn website:build
+
+      - name: Deploy documentation
+        uses: nwtgck/[email protected]
+        with:
+          publish-dir: 'website/build'
+          production-branch: main
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          deploy-message: 'Deploy from GitHub Actions'
+          enable-pull-request-comment: true
+          enable-commit-comment: true
+          overwrites-pull-request-comment: true
+          netlify-config-path: ./netlify.toml
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+        timeout-minutes: 5
+
       - name: Push generated code
         id: pushGeneratedCode
         run: yarn workspace scripts pushGeneratedCode

clients/algoliasearch-client-go/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [4.0.0-beta.5](https://github.com/algolia/algoliasearch-client-go/compare/4.0.0-beta.4...4.0.0-beta.5)
+
+- [115dd1778](https://github.com/algolia/api-clients-automation/commit/115dd1778) chore(go): add missing ACLs in description, remove duplicated deprecation notice ([#2825](https://github.com/algolia/api-clients-automation/pull/2825)) by [@shortcuts](https://github.com/shortcuts/)
+
 ## [4.0.0-beta.4](https://github.com/algolia/algoliasearch-client-go/compare/4.0.0-beta.3...4.0.0-beta.4)
 
 - [a138c2fef](https://github.com/algolia/api-clients-automation/commit/a138c2fef) fix(specs): add `queryID` to search response ([#2801](https://github.com/algolia/api-clients-automation/pull/2801)) by [@aallam](https://github.com/aallam/)

clients/algoliasearch-client-go/algolia/abtesting/api_abtesting.go

@@ -92,6 +92,9 @@ AddABTests
 
 Creates an A/B test.
 
+Required API Key ACLs:
+  - editSettings
+
 Request can be constructed by NewApiAddABTestsRequest with parameters below.
 
 	@param addABTestsRequest AddABTestsRequest
@@ -828,6 +831,9 @@ DeleteABTest
 Delete an A/B test.
 To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
 
+Required API Key ACLs:
+  - editSettings
+
 Request can be constructed by NewApiDeleteABTestRequest with parameters below.
 
 	@param id int32 - Unique A/B test ID.
@@ -947,6 +953,9 @@ GetABTest
 Get specific details for an A/B test.
 To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetABTestRequest with parameters below.
 
 	@param id int32 - Unique A/B test ID.
@@ -1119,6 +1128,9 @@ ListABTests
 
 List all A/B tests.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiListABTestsRequest with parameters below.
 
 	@param offset int32 - Position of the starting record. Used for paging. 0 is the first record.
@@ -1255,6 +1267,9 @@ If stopped, the test is over and can't be restarted. There is now only one index
 The data gathered for stopped A/B tests is retained.
 To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
 
+Required API Key ACLs:
+  - editSettings
+
 Request can be constructed by NewApiStopABTestRequest with parameters below.
 
 	@param id int32 - Unique A/B test ID.

clients/algoliasearch-client-go/algolia/abtesting/client.go

@@ -94,7 +94,7 @@ func getDefaultHosts(r Region) []transport.StatefulHost {
 }
 
 func getUserAgent() string {
-	return fmt.Sprintf("Algolia for Go (4.0.0-beta.4); Go (%s); Abtesting (4.0.0-beta.4)", runtime.Version())
+	return fmt.Sprintf("Algolia for Go (4.0.0-beta.5); Go (%s); Abtesting (4.0.0-beta.5)", runtime.Version())
 }
 
 // queryParameterToString convert any query parameters to string.

clients/algoliasearch-client-go/algolia/analytics/api_analytics.go

@@ -752,6 +752,9 @@ GetAverageClickPosition
 Return the average click position for the complete time range and for individual days.
 > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetAverageClickPositionRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -940,6 +943,9 @@ Show the number of clicks events and their associated position in the search res
 
 > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetClickPositionsRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -1124,6 +1130,9 @@ GetClickThroughRate
 
 Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetClickThroughRateRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -1308,6 +1317,9 @@ GetConversationRate
 
 Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetConversationRateRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -1492,6 +1504,9 @@ GetNoClickRate
 
 Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetNoClickRateRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -1676,6 +1691,9 @@ GetNoResultsRate
 
 Returns the rate at which searches didn't return any results.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetNoResultsRateRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -1860,6 +1878,9 @@ GetSearchesCount
 
 Returns the number of searches within a time range.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetSearchesCountRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -2078,6 +2099,9 @@ GetSearchesNoClicks
 
 Return the most popular of the last 1,000 searches that didn't lead to any clicks.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetSearchesNoClicksRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -2304,6 +2328,9 @@ GetSearchesNoResults
 
 Returns the most popular of the latest 1,000 searches that didn't return any results.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetSearchesNoResultsRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -2447,6 +2474,9 @@ GetStatus
 Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`.
 > **Note**: The Analytics API is updated every 5 minutes.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetStatusRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -2653,6 +2683,9 @@ GetTopCountries
 
 Returns top countries. Limited to the 1,000 most frequent ones.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetTopCountriesRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -2896,6 +2929,9 @@ GetTopFilterAttributes
 
 Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetTopFilterAttributesRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -3155,6 +3191,9 @@ GetTopFilterForAttribute
 
 Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetTopFilterForAttributeRequest with parameters below.
 
 	@param attribute string - Attribute name.
@@ -3407,6 +3446,9 @@ GetTopFiltersNoResults
 
 Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetTopFiltersNoResultsRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -3671,6 +3713,9 @@ GetTopHits
 
 Return the most popular clicked results in the last 1,000 searches.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetTopHitsRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -3956,6 +4001,9 @@ GetTopSearches
 
 Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetTopSearchesRequest with parameters below.
 
 	@param index string - Index name to target.
@@ -4160,6 +4208,9 @@ GetUsersCount
 
 Return the count of unique users.
 
+Required API Key ACLs:
+  - analytics
+
 Request can be constructed by NewApiGetUsersCountRequest with parameters below.
 
 	@param index string - Index name to target.

clients/algoliasearch-client-go/algolia/analytics/client.go

@@ -94,7 +94,7 @@ func getDefaultHosts(r Region) []transport.StatefulHost {
 }
 
 func getUserAgent() string {
-	return fmt.Sprintf("Algolia for Go (4.0.0-beta.4); Go (%s); Analytics (4.0.0-beta.4)", runtime.Version())
+	return fmt.Sprintf("Algolia for Go (4.0.0-beta.5); Go (%s); Analytics (4.0.0-beta.5)", runtime.Version())
 }
 
 // queryParameterToString convert any query parameters to string.