Merge branch 'main' into feat/add-onboarding-snippets

Author: millotp

.eslintrc.cjs

@@ -121,7 +121,7 @@ module.exports = {
         '@typescript-eslint/no-namespace': 0,
         'import/dynamic-import-chunkname': 0,
 
-        'unused-imports/no-unused-imports-ts': 2,
+        'unused-imports/no-unused-imports': 2,
         '@typescript-eslint/no-unused-vars': 2,
         '@typescript-eslint/consistent-indexed-object-style': 2,
         '@typescript-eslint/member-ordering': [
@@ -205,8 +205,6 @@ module.exports = {
     {
       files: ['clients/algoliasearch-client-javascript/packages/**/__tests__/**/*.ts'],
 
-      extends: ["plugin:vitest/legacy-recommended"],
-
       plugins: ['@vitest/eslint-plugin'],
     },
     {

.github/actions/setup/action.yml

@@ -34,7 +34,7 @@ runs:
     - name: Download Java formatter
       if: inputs.type != 'minimal'
       shell: bash
-      run: curl --retry 3 -L "https://github.com/google/google-java-format/releases/download/v1.23.0/google-java-format-1.23.0-all-deps.jar" > /tmp/java-formatter.jar
+      run: curl --retry 3 -L "https://github.com/google/google-java-format/releases/download/v1.24.0/google-java-format-1.24.0-all-deps.jar" > /tmp/java-formatter.jar
 
     # JavaScript for monorepo and tooling
     - name: Install Node

.github/workflows/check.yml

@@ -571,12 +571,17 @@ jobs:
           } >> "$GITHUB_OUTPUT"
           rm -rf tests/output/**/benchmarkResult.json
 
+      - name: Extract branch name
+        id: extract_branch
+        run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
+        
       - name: Push generated code
         id: pushGeneratedCode
         run: yarn workspace scripts pushGeneratedCode
         env:
           GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN != '' && secrets.ALGOLIA_BOT_TOKEN || secrets.GITHUB_TOKEN }}
           PR_NUMBER: ${{ github.event.number }}
+          BRANCH_NAME: ${{ steps.extract_branch.outputs.branch }}
 
       - name: update generation comment
         uses: marocchino/sticky-pull-request-comment@v2
@@ -663,8 +668,9 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          ref: ${{ github.event.pull_request.head.ref }}
+          ref: ${{ needs.codegen.outputs.generatedCommit }}
           token: ${{ secrets.ALGOLIA_BOT_TOKEN }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
 
       - name: Setup
         uses: ./.github/actions/setup

.github/workflows/cleanup.yml

@@ -14,4 +14,4 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - run: git push -d origin generated/${{ github.head_ref }} || true
+      - run: git push -d origin "generated/${{ github.head_ref }}" || true

.gitignore

@@ -20,6 +20,7 @@ target
 **/.DS_Store
 .gradle
 build
+.build
 pom.xml
 
 dist

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

@@ -1,7 +1,7 @@
 /*
 * Search API
 *
-* The Algolia Search API lets you search, configure, and mange your indices and records.  ## Client libraries  Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/).  See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/)  ## Base URLs  The base URLs for requests to the Search API are:  - `https://{APPLICATION_ID}.algolia.net` - `https://{APPLICATION_ID}-dsn.algolia.net`.   If your subscription includes a [Distributed Search Network](https://dashboard.algolia.com/infra),   this ensures that requests are sent to servers closest to users.  Both URLs provide high availability by distributing requests with load balancing.  **All requests must use HTTPS.**  ## Retry strategy  To guarantee a high availability, implement a retry strategy for all API requests using the URLs of your servers as fallbacks:  - `https://{APPLICATION_ID}-1.algolianet.com` - `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com`  These URLs use a different DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.  All Algolia API clients implement this retry strategy.  ## 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  Depending on the endpoint, request bodies are either JSON objects or arrays of JSON objects,  ## Parameters  Parameters are passed as query parameters for GET and DELETE requests, and in the request body for POST and PUT requests.  Query parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. Arrays as query parameters must be one of:  - A comma-separated string: `attributesToRetrieve=title,description` - A URL-encoded JSON array: `attributesToRetrieve=%5B%22title%22,%22description%22%D`  ## Response status and errors  The Search API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.  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 Search API is version 1, as indicated by the `/1/` in each endpoint's URL. 
+* The Algolia Search API lets you search, configure, and manage your indices and records.  ## Client libraries  Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/).  See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/)  ## Base URLs  The base URLs for requests to the Search API are:  - `https://{APPLICATION_ID}.algolia.net` - `https://{APPLICATION_ID}-dsn.algolia.net`.   If your subscription includes a [Distributed Search Network](https://dashboard.algolia.com/infra),   this ensures that requests are sent to servers closest to users.  Both URLs provide high availability by distributing requests with load balancing.  **All requests must use HTTPS.**  ## Retry strategy  To guarantee high availability, implement a retry strategy for all API requests using the URLs of your servers as fallbacks:  - `https://{APPLICATION_ID}-1.algolianet.com` - `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com`  These URLs use a different DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.  All Algolia API clients implement this retry strategy.  ## 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  Depending on the endpoint, request bodies are either JSON objects or arrays of JSON objects,  ## Parameters  Parameters are passed as query parameters for GET and DELETE requests, and in the request body for POST and PUT requests.  Query parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. Arrays as query parameters must be one of:  - A comma-separated string: `attributesToRetrieve=title,description` - A URL-encoded JSON array: `attributesToRetrieve=%5B%22title%22,%22description%22%D`  ## Response status and errors  The Search API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.  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 Search 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/SearchConfiguration.cs

@@ -0,0 +1,100 @@
+//
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+//
+using System;
+using System.Text;
+using System.Linq;
+using System.Text.Json.Serialization;
+using System.Collections.Generic;
+using Algolia.Search.Serializer;
+using System.Text.Json;
+
+namespace Algolia.Search.Models.Recommend;
+
+/// <summary>
+/// a search banner with image and url.
+/// </summary>
+public partial class Banner
+{
+  /// <summary>
+  /// Initializes a new instance of the Banner class.
+  /// </summary>
+  public Banner()
+  {
+  }
+
+  /// <summary>
+  /// Gets or Sets Image
+  /// </summary>
+  [JsonPropertyName("image")]
+  public BannerImage Image { get; set; }
+
+  /// <summary>
+  /// Gets or Sets Link
+  /// </summary>
+  [JsonPropertyName("link")]
+  public BannerLink Link { get; set; }
+
+  /// <summary>
+  /// Returns the string presentation of the object
+  /// </summary>
+  /// <returns>String presentation of the object</returns>
+  public override string ToString()
+  {
+    StringBuilder sb = new StringBuilder();
+    sb.Append("class Banner {\n");
+    sb.Append("  Image: ").Append(Image).Append("\n");
+    sb.Append("  Link: ").Append(Link).Append("\n");
+    sb.Append("}\n");
+    return sb.ToString();
+  }
+
+  /// <summary>
+  /// Returns the JSON string presentation of the object
+  /// </summary>
+  /// <returns>JSON string presentation of the object</returns>
+  public virtual string ToJson()
+  {
+    return JsonSerializer.Serialize(this, JsonConfig.Options);
+  }
+
+  /// <summary>
+  /// Returns true if objects are equal
+  /// </summary>
+  /// <param name="obj">Object to be compared</param>
+  /// <returns>Boolean</returns>
+  public override bool Equals(object obj)
+  {
+    if (obj is not Banner input)
+    {
+      return false;
+    }
+
+    return
+        (Image == input.Image || (Image != null && Image.Equals(input.Image))) &&
+        (Link == input.Link || (Link != null && Link.Equals(input.Link)));
+  }
+
+  /// <summary>
+  /// Gets the hash code
+  /// </summary>
+  /// <returns>Hash code</returns>
+  public override int GetHashCode()
+  {
+    unchecked // Overflow is fine, just wrap
+    {
+      int hashCode = 41;
+      if (Image != null)
+      {
+        hashCode = (hashCode * 59) + Image.GetHashCode();
+      }
+      if (Link != null)
+      {
+        hashCode = (hashCode * 59) + Link.GetHashCode();
+      }
+      return hashCode;
+    }
+  }
+
+}
+

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/Banner.cs

@@ -0,0 +1,100 @@
+//
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+//
+using System;
+using System.Text;
+using System.Linq;
+using System.Text.Json.Serialization;
+using System.Collections.Generic;
+using Algolia.Search.Serializer;
+using System.Text.Json;
+
+namespace Algolia.Search.Models.Recommend;
+
+/// <summary>
+/// image of a search banner.
+/// </summary>
+public partial class BannerImage
+{
+  /// <summary>
+  /// Initializes a new instance of the BannerImage class.
+  /// </summary>
+  public BannerImage()
+  {
+  }
+
+  /// <summary>
+  /// Gets or Sets Urls
+  /// </summary>
+  [JsonPropertyName("urls")]
+  public BannerImageUrl Urls { get; set; }
+
+  /// <summary>
+  /// Gets or Sets Title
+  /// </summary>
+  [JsonPropertyName("title")]
+  public string Title { get; set; }
+
+  /// <summary>
+  /// Returns the string presentation of the object
+  /// </summary>
+  /// <returns>String presentation of the object</returns>
+  public override string ToString()
+  {
+    StringBuilder sb = new StringBuilder();
+    sb.Append("class BannerImage {\n");
+    sb.Append("  Urls: ").Append(Urls).Append("\n");
+    sb.Append("  Title: ").Append(Title).Append("\n");
+    sb.Append("}\n");
+    return sb.ToString();
+  }
+
+  /// <summary>
+  /// Returns the JSON string presentation of the object
+  /// </summary>
+  /// <returns>JSON string presentation of the object</returns>
+  public virtual string ToJson()
+  {
+    return JsonSerializer.Serialize(this, JsonConfig.Options);
+  }
+
+  /// <summary>
+  /// Returns true if objects are equal
+  /// </summary>
+  /// <param name="obj">Object to be compared</param>
+  /// <returns>Boolean</returns>
+  public override bool Equals(object obj)
+  {
+    if (obj is not BannerImage input)
+    {
+      return false;
+    }
+
+    return
+        (Urls == input.Urls || (Urls != null && Urls.Equals(input.Urls))) &&
+        (Title == input.Title || (Title != null && Title.Equals(input.Title)));
+  }
+
+  /// <summary>
+  /// Gets the hash code
+  /// </summary>
+  /// <returns>Hash code</returns>
+  public override int GetHashCode()
+  {
+    unchecked // Overflow is fine, just wrap
+    {
+      int hashCode = 41;
+      if (Urls != null)
+      {
+        hashCode = (hashCode * 59) + Urls.GetHashCode();
+      }
+      if (Title != null)
+      {
+        hashCode = (hashCode * 59) + Title.GetHashCode();
+      }
+      return hashCode;
+    }
+  }
+
+}
+

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/BannerImage.cs

@@ -0,0 +1,88 @@
+//
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+//
+using System;
+using System.Text;
+using System.Linq;
+using System.Text.Json.Serialization;
+using System.Collections.Generic;
+using Algolia.Search.Serializer;
+using System.Text.Json;
+
+namespace Algolia.Search.Models.Recommend;
+
+/// <summary>
+/// url for a search banner image.
+/// </summary>
+public partial class BannerImageUrl
+{
+  /// <summary>
+  /// Initializes a new instance of the BannerImageUrl class.
+  /// </summary>
+  public BannerImageUrl()
+  {
+  }
+
+  /// <summary>
+  /// Gets or Sets Url
+  /// </summary>
+  [JsonPropertyName("url")]
+  public string Url { get; set; }
+
+  /// <summary>
+  /// Returns the string presentation of the object
+  /// </summary>
+  /// <returns>String presentation of the object</returns>
+  public override string ToString()
+  {
+    StringBuilder sb = new StringBuilder();
+    sb.Append("class BannerImageUrl {\n");
+    sb.Append("  Url: ").Append(Url).Append("\n");
+    sb.Append("}\n");
+    return sb.ToString();
+  }
+
+  /// <summary>
+  /// Returns the JSON string presentation of the object
+  /// </summary>
+  /// <returns>JSON string presentation of the object</returns>
+  public virtual string ToJson()
+  {
+    return JsonSerializer.Serialize(this, JsonConfig.Options);
+  }
+
+  /// <summary>
+  /// Returns true if objects are equal
+  /// </summary>
+  /// <param name="obj">Object to be compared</param>
+  /// <returns>Boolean</returns>
+  public override bool Equals(object obj)
+  {
+    if (obj is not BannerImageUrl input)
+    {
+      return false;
+    }
+
+    return
+        (Url == input.Url || (Url != null && Url.Equals(input.Url)));
+  }
+
+  /// <summary>
+  /// Gets the hash code
+  /// </summary>
+  /// <returns>Hash code</returns>
+  public override int GetHashCode()
+  {
+    unchecked // Overflow is fine, just wrap
+    {
+      int hashCode = 41;
+      if (Url != null)
+      {
+        hashCode = (hashCode * 59) + Url.GetHashCode();
+      }
+      return hashCode;
+    }
+  }
+
+}
+