Merge branch 'main' into chore/codacy-fixes

Author: millotp

.github/workflows/check.yml

@@ -222,7 +222,7 @@ jobs:
         run: ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).buildCommand }}
 
       - name: Build the playground
-        run: yarn cli build playground javascript
+        run: yarn cli build playground javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
 
       - name: Run common and requester tests
         run: cd clients/algoliasearch-client-javascript && yarn test ${{ !contains(fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun, 'algoliasearch') && '--ignore algoliasearch' || '' }}
@@ -279,13 +279,13 @@ jobs:
         run: yarn cli snippets javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
 
       - name: Build the snippets to check validity
-        run: yarn cli build snippets javascript
+        run: yarn cli build snippets javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
 
       - name: Generate code guides
         run: yarn cli guides javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
 
       - name: Build the guides to check validity
-        run: yarn cli build guides javascript
+        run: yarn cli build guides javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
 
       - name: Zip artifact before storing
         run: zip -r -y clients-javascript.zip clients/algoliasearch-client-javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).testsToStore }} ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).guidesToStore }} -x "**/node_modules**" "**/.yarn/cache/**" "**/.yarn/install-state.gz" "**/build/**" "**/dist/**" "**/.gradle/**" "**/bin/**" "**/.nx/**"
@@ -689,7 +689,12 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN }}
 
-      - name: Push generation to the Algolia docs
+      - name: Push specs and snippets to algolia/doc
         run: yarn workspace scripts pushToAlgoliaDoc
         env:
           GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN }}
+
+      - name: Push guides to algolia/AlgoliaWeb
+        run: yarn workspace scripts pushToAlgoliaWeb
+        env:
+          GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN }}

.github/workflows/push-to-algolia-web.yml

@@ -0,0 +1,24 @@
+name: Push snippets to AlgoliaWeb
+
+on: workflow_dispatch
+
+jobs:
+  push:
+    name: Manual trigger push for onboarding guides
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: main
+
+      - name: Setup
+        id: setup
+        uses: ./.github/actions/setup
+        with:
+          type: minimal
+
+      - run: yarn workspace scripts pushToAlgoliaWeb
+        env:
+          GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN }}
+          FORCE: true

clients/algoliasearch-client-csharp/algoliasearch/Algolia.Search.csproj

@@ -39,7 +39,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.1" />
-    <PackageReference Include="System.Text.Json" Version="8.0.4" />
+    <PackageReference Include="System.Text.Json" Version="8.0.5" />
   </ItemGroup>
 
   <ItemGroup>

clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionClient.cs

@@ -980,7 +980,7 @@ public interface IIngestionClient
   ListDestinationsResponse ListDestinations(int? itemsPerPage = default, int? page = default, List<DestinationType> type = default, List<string> authenticationID = default, string transformationID = default, DestinationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Retrieves a list of events for a task run, identified by it's ID.
+  /// Retrieves a list of events for a task run, identified by its ID.
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -1005,7 +1005,7 @@ public interface IIngestionClient
   Task<ListEventsResponse> ListEventsAsync(string runID, int? itemsPerPage = default, int? page = default, List<EventStatus> status = default, List<EventType> type = default, EventSortKeys? sort = default, OrderKeys? order = default, string startDate = default, string endDate = default, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Retrieves a list of events for a task run, identified by it's ID. (Synchronous version)
+  /// Retrieves a list of events for a task run, identified by its ID. (Synchronous version)
   /// </summary>
   ///
   /// Required API Key ACLs:

clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionConfiguration.cs

@@ -1,7 +1,7 @@
 /*
 * Ingestion API
 *
-* The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks to ingest your data. The Ingestion API powers the no-code [data connectors](https://dashboard.algolia.com/connectors).  ## Base URLs  The base URLs for requests to the Ingestion API are:  - `https://data.us.algolia.com` - `https://data.eu.algolia.com`  Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).  **All requests must use HTTPS.**  ## Authentication  To authenticate your API requests, add these headers:  - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request.   The required access control list (ACL) to make a request is listed in each endpoint's reference.  You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).  ## Request format  Request bodies must be JSON objects.  ## Response status and errors  Response bodies are JSON objects. Deleting a user token returns an empty response body with rate-limiting information as headers.  Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information.  The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia features such as Analytics, or Dynamic Re-Ranking.  ## Version  The current version of the Insights API is version 1, as indicated by the `/1/` in each endpoint's URL. 
+* The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks to ingest your data. The Ingestion API powers the no-code [data connectors](https://dashboard.algolia.com/connectors).  ## Base URLs  The base URLs for requests to the Ingestion API are:  - `https://data.us.algolia.com` - `https://data.eu.algolia.com`  Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).  **All requests must use HTTPS.**  ## Authentication  To authenticate your API requests, add these headers:  - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request.   The required access control list (ACL) to make a request is listed in each endpoint's reference.  You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).  ## Request format  Request bodies must be JSON objects.  ## Response status and errors  Response bodies are JSON objects. Deleting a user token returns an empty response body with rate-limiting information as headers.  Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information.  ## Version  The current version of the Ingestion API is version 1, as indicated by the `/1/` in each endpoint's URL. 
 *
 * The version of the OpenAPI document: 1.0.0
 * Generated by: https://github.com/openapitools/openapi-generator.git

clients/algoliasearch-client-csharp/algoliasearch/Clients/InsightsConfiguration.cs

@@ -1,7 +1,7 @@
 /*
 * Insights API
 *
-* The Insights API lets you collect events related to your search and discovery experience. Events represent user interactions with your app or website. They unlock powerful features, such as recommendations, personalization, smarter search results, and analytics that help you optimize your user experience.  ## Client libraries  Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the Insights API. See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/)  ## Base URLs  The base URLs for making requests to the Insights API are:  - `https://insights.us.algolia.io` - `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above servers, based on your geographical location)  **All requests must use HTTPS.**  ## Authentication  To authenticate your API requests, add these headers:  - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request.   The required access control list (ACL) to make a request is listed in each endpoint's reference.  You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).  ## Request format  Request bodies must be JSON objects.  ## Response status and errors  Response bodies are JSON objects. Deleting a user token returns an empty response body with rate-limiting information as headers.  Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information.  The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia features such as Analytics, or Dynamic Re-Ranking.  ## Version  The current version of the Insights API is version 1, as indicated by the `/1/` in each endpoint's URL. 
+* The Insights API lets you collect events related to your search and discovery experience. Events represent user interactions with your app or website. They unlock powerful features, such as recommendations, personalization, smarter search results, and analytics that help you optimize your user experience.  ## Client libraries  Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the Insights API. See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/).  ## Base URLs  The base URLs for making requests to the Insights API are:  - `https://insights.us.algolia.io` - `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above servers, based on your geographical location)  **All requests must use HTTPS.**  ## Authentication  To authenticate your API requests, add these headers:  - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request.   The required access control list (ACL) to make a request is listed in each endpoint's reference.  You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).  ## Request format  Request bodies must be JSON objects.  ## Response status and errors  Response bodies are JSON objects. Deleting a user token returns an empty response body with rate-limiting information as headers.  Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information.  The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or `userToken`, correspond to anything in the Search API. It just checks if they're formatted correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia features such as Analytics, or Dynamic Re-Ranking.  ## Version  The current version of the Insights API is version 1, as indicated by the `/1/` in each endpoint's URL. 
 *
 * The version of the OpenAPI document: 1.0.0
 * Generated by: https://github.com/openapitools/openapi-generator.git

clients/algoliasearch-client-csharp/algoliasearch/Clients/MonitoringClient.cs

@@ -132,7 +132,7 @@ public interface IMonitoringClient
   /// <summary>
   /// Retrieves known incidents for the selected clusters.
   /// </summary>
-  /// <param name="clusters">Subset of clusters, separated by comma.</param>
+  /// <param name="clusters">Subset of clusters, separated by commas.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -144,7 +144,7 @@ public interface IMonitoringClient
   /// <summary>
   /// Retrieves known incidents for the selected clusters. (Synchronous version)
   /// </summary>
-  /// <param name="clusters">Subset of clusters, separated by comma.</param>
+  /// <param name="clusters">Subset of clusters, separated by commas.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -156,7 +156,7 @@ public interface IMonitoringClient
   /// <summary>
   /// Retrieves the status of selected clusters.
   /// </summary>
-  /// <param name="clusters">Subset of clusters, separated by comma.</param>
+  /// <param name="clusters">Subset of clusters, separated by commas.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -168,7 +168,7 @@ public interface IMonitoringClient
   /// <summary>
   /// Retrieves the status of selected clusters. (Synchronous version)
   /// </summary>
-  /// <param name="clusters">Subset of clusters, separated by comma.</param>
+  /// <param name="clusters">Subset of clusters, separated by commas.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -202,7 +202,7 @@ public interface IMonitoringClient
   /// <summary>
   /// Retrieves average times for indexing operations for selected clusters.
   /// </summary>
-  /// <param name="clusters">Subset of clusters, separated by comma.</param>
+  /// <param name="clusters">Subset of clusters, separated by commas.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -214,7 +214,7 @@ public interface IMonitoringClient
   /// <summary>
   /// Retrieves average times for indexing operations for selected clusters. (Synchronous version)
   /// </summary>
-  /// <param name="clusters">Subset of clusters, separated by comma.</param>
+  /// <param name="clusters">Subset of clusters, separated by commas.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -226,7 +226,7 @@ public interface IMonitoringClient
   /// <summary>
   /// Retrieves the average latency for search requests for selected clusters.
   /// </summary>
-  /// <param name="clusters">Subset of clusters, separated by comma.</param>
+  /// <param name="clusters">Subset of clusters, separated by commas.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -238,7 +238,7 @@ public interface IMonitoringClient
   /// <summary>
   /// Retrieves the average latency for search requests for selected clusters. (Synchronous version)
   /// </summary>
-  /// <param name="clusters">Subset of clusters, separated by comma.</param>
+  /// <param name="clusters">Subset of clusters, separated by commas.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -276,7 +276,7 @@ public interface IMonitoringClient
   /// <summary>
   /// Test whether clusters are reachable or not.
   /// </summary>
-  /// <param name="clusters">Subset of clusters, separated by comma.</param>
+  /// <param name="clusters">Subset of clusters, separated by commas.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -288,7 +288,7 @@ public interface IMonitoringClient
   /// <summary>
   /// Test whether clusters are reachable or not. (Synchronous version)
   /// </summary>
-  /// <param name="clusters">Subset of clusters, separated by comma.</param>
+  /// <param name="clusters">Subset of clusters, separated by commas.</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>

clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/Transformation.cs

@@ -44,9 +44,9 @@ public Transformation(string transformationID, string code, string name, string
   public string TransformationID { get; set; }
 
   /// <summary>
-  /// The authentications associated for the current transformation.
+  /// The authentications associated with the current transformation.
   /// </summary>
-  /// <value>The authentications associated for the current transformation.</value>
+  /// <value>The authentications associated with the current transformation.</value>
   [JsonPropertyName("authenticationIDs")]
   public List<string> AuthenticationIDs { get; set; }
 

clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/TransformationCreate.cs

@@ -54,9 +54,9 @@ public TransformationCreate(string code, string name)
   public string Description { get; set; }
 
   /// <summary>
-  /// The authentications associated for the current transformation.
+  /// The authentications associated with the current transformation.
   /// </summary>
-  /// <value>The authentications associated for the current transformation.</value>
+  /// <value>The authentications associated with the current transformation.</value>
   [JsonPropertyName("authenticationIDs")]
   public List<string> AuthenticationIDs { get; set; }