Merge branch 'main' into feat/add-chopper-requester-package

Author: shortcuts

.github/actions/setup/action.yml

@@ -211,7 +211,7 @@ runs:
       if: ${{ inputs.language == 'swift' }}
       id: swiftformat-version
       shell: bash
-      run: echo "SWIFTFORMAT_VERSION=0.54.0" >> $GITHUB_OUTPUT
+      run: echo "SWIFTFORMAT_VERSION=0.54.1" >> $GITHUB_OUTPUT
 
     - name: Checkout swiftformat
       if: ${{ inputs.language == 'swift' }}

.github/workflows/check.yml

@@ -241,8 +241,18 @@ jobs:
           path: tests/output/javascript/node_modules
           key: node-modules-tests-${{ hashFiles('tests/output/javascript/yarn.lock') }}
 
-      - name: Run CTS
-        run: yarn cli cts run javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
+      - name: Run unit CTS
+        run: yarn cli cts run javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }} --exclude-e2e
+
+      - name: Run e2e CTS
+        id: cts-e2e
+        continue-on-error: true
+        if: ${{ !github.event.pull_request.head.repo.fork }}
+        run: yarn cli cts run javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }} --exclude-unit
+
+      - name: Retry e2e CTS
+        if: ${{ !github.event.pull_request.head.repo.fork && steps.cts-e2e.outcome == 'failure' }}
+        run: yarn cli cts run javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }} --exclude-unit
 
       - name: Generate code snippets for documentation
         run: yarn cli snippets javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
@@ -325,8 +335,18 @@ jobs:
       - name: Generate CTS
         run: yarn cli cts generate ${{ matrix.client.language }} ${{ matrix.client.toRun }}
 
-      - name: Run CTS
-        run: yarn cli cts run ${{ matrix.client.language }} ${{ matrix.client.toRun }}
+      - name: Run unit CTS
+        run: yarn cli cts run ${{ matrix.client.language }} ${{ matrix.client.toRun }} --exclude-e2e
+
+      - name: Run e2e CTS
+        id: cts-e2e
+        continue-on-error: true
+        if: ${{ !github.event.pull_request.head.repo.fork }}
+        run: yarn cli cts run ${{ matrix.client.language }} ${{ matrix.client.toRun }} --exclude-unit
+
+      - name: Retry e2e CTS
+        if: ${{ !github.event.pull_request.head.repo.fork && steps.cts-e2e.outcome == 'failure' }}
+        run: yarn cli cts run ${{ matrix.client.language }} ${{ matrix.client.toRun }} --exclude-unit
 
       - name: Generate code snippets for documentation
         run: yarn cli snippets ${{ matrix.client.language }} ${{ matrix.client.toRun }}
@@ -353,6 +373,8 @@ jobs:
       needs.setup.outputs.RUN_MACOS_KOTLIN_BUILD == 'true' &&
       !contains(needs.*.result, 'cancelled') &&
       !contains(needs.*.result, 'failure')
+    outputs:
+      success: ${{ steps.setoutput.outputs.success }}
     steps:
       - uses: actions/checkout@v4
 
@@ -371,6 +393,10 @@ jobs:
 
       - run: yarn cli build clients kotlin
 
+      - name: Set output
+        id: setoutput
+        run: echo "success=true" >> "$GITHUB_OUTPUT"
+
   swift_cts_macos:
     timeout-minutes: 20
     runs-on: macos-latest
@@ -379,7 +405,6 @@ jobs:
       - client_gen
     if: |
       always() &&
-      startsWith(github.head_ref, 'chore/prepare-release-') &&
       needs.setup.outputs.RUN_GEN == 'true' &&
       needs.setup.outputs.RUN_MACOS_SWIFT_CTS == 'true' &&
       !contains(needs.*.result, 'cancelled') &&
@@ -388,6 +413,8 @@ jobs:
       ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
       ALGOLIA_ADMIN_KEY: ${{ secrets.ALGOLIA_ADMIN_KEY }}
       MONITORING_API_KEY: ${{ secrets.MONITORING_API_KEY }}
+    outputs:
+      success: ${{ steps.setoutput.outputs.success }}
     steps:
       - uses: actions/checkout@v4
 
@@ -406,6 +433,10 @@ jobs:
 
       - run: yarn cli cts run swift ${{ fromJSON(needs.setup.outputs.SWIFT_DATA).toRun }}
 
+      - name: Set output
+        id: setoutput
+        run: echo "success=true" >> "$GITHUB_OUTPUT"
+
   codegen:
     runs-on: ubuntu-22.04
     timeout-minutes: 15
@@ -443,27 +474,6 @@ jobs:
       - name: Generate documentation specs with code snippets
         run: yarn cli build specs ${{ fromJSON(needs.setup.outputs.SPECS_MATRIX).toRun }} --docs
 
-      - name: Build website
-        if: ${{ github.ref == 'refs/heads/main' || github.base_ref == 'main' }}
-        run: yarn website:build
-
-      - name: Deploy documentation
-        if: ${{ github.ref == 'refs/heads/main' || github.base_ref == 'main' }}
-        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
@@ -494,6 +504,27 @@ jobs:
             | 🪓 Triggered by | [`${{ github.sha }}`](${{ github.event.pull_request.base.repo.html_url }}/commit/${{ github.sha }}) |
             | 🍃 Generated commit | [`${{ steps.pushGeneratedCode.outputs.GENERATED_COMMIT }}`](${{ github.event.pull_request.base.repo.html_url }}/commit/${{ steps.pushGeneratedCode.outputs.GENERATED_COMMIT }}) |
             | 🌲 Generated branch | [`generated/${{ github.head_ref }}`](${{ github.event.pull_request.base.repo.html_url }}/tree/generated/${{ github.head_ref }}) |
+    
+      - name: Build website
+        if: ${{ github.ref == 'refs/heads/main' || github.base_ref == 'main' }}
+        run: yarn website:build
+
+      - name: Deploy documentation
+        if: ${{ github.ref == 'refs/heads/main' || github.base_ref == 'main' }}
+        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: Set output
         id: setoutput
@@ -509,8 +540,8 @@ jobs:
     if: always()
     steps:
       - run: |
-          if [[ "${{ needs.codegen.outputs.success }}" != "true" ]]; then
-            echo "codegen step didn't succeed"
+          if [[ ("${{ needs.codegen.outputs.success }}" != "true") || ("${{ needs.swift_cts_macos.result }}" != "skipped" && "${{ needs.swift_cts_macos.outputs.success }}" != "true") || ("${{ needs.kotlin_build_macos.result }}" != "skipped" && "${{ needs.kotlin_build_macos.outputs.success }}" != "true")]]; then
+            echo "a needed step failed"
             exit 1
           fi
 
@@ -522,6 +553,8 @@ jobs:
       - check_green
     if: |
       always() &&
+      !contains(needs.*.result, 'cancelled') &&
+      !contains(needs.*.result, 'failure') &&
       github.ref == 'refs/heads/main'
     permissions:
       pull-requests: write

.nvmrc

@@ -1 +1 @@
-20.15.0
+20.15.1

clients/algoliasearch-client-csharp/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [7.0.0-beta.9](https://github.com/algolia/algoliasearch-client-csharp/compare/7.0.0-beta.8...7.0.0-beta.9)
+
+- [a009967f6](https://github.com/algolia/api-clients-automation/commit/a009967f6) fix(specs): browse response required properties ([#3348](https://github.com/algolia/api-clients-automation/pull/3348)) by [@millotp](https://github.com/millotp/)
+- [04a799417](https://github.com/algolia/api-clients-automation/commit/04a799417) fix(specs): ingestion task and transformation ([#3347](https://github.com/algolia/api-clients-automation/pull/3347)) by [@shortcuts](https://github.com/shortcuts/)
+- [dcb1b59dc](https://github.com/algolia/api-clients-automation/commit/dcb1b59dc) fix(specs): clarify browse parameters ([#3333](https://github.com/algolia/api-clients-automation/pull/3333)) by [@kai687](https://github.com/kai687/)
+
 ## [7.0.0-beta.8](https://github.com/algolia/algoliasearch-client-csharp/compare/7.0.0-beta.7...7.0.0-beta.8)
 
 - [9776cb3ba](https://github.com/algolia/api-clients-automation/commit/9776cb3ba) feat(specs): add redirect to renderingContent ([#3296](https://github.com/algolia/api-clients-automation/pull/3296)) by [@shortcuts](https://github.com/shortcuts/)

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

@@ -21,7 +21,7 @@
     <RepositoryType>git</RepositoryType>
     <RequireLicenseAcceptance>false</RequireLicenseAcceptance>
     <Copyright>Copyright 2019 Algolia</Copyright>
-    <Version>7.0.0-beta.8</Version>
+    <Version>7.0.0-beta.9</Version>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <TargetFrameworks>netstandard2.1;netstandard2.0</TargetFrameworks>
     <IncludeSymbols>true</IncludeSymbols>

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

@@ -27,17 +27,9 @@ public BaseSearchResponse()
   /// <summary>
   /// Initializes a new instance of the BaseSearchResponse class.
   /// </summary>
-  /// <param name="hitsPerPage">Number of hits per page. (required) (default to 20).</param>
-  /// <param name="nbHits">Number of results (hits). (required).</param>
-  /// <param name="nbPages">Number of pages of results. (required).</param>
-  /// <param name="page">Page of search results to retrieve. (required) (default to 0).</param>
   /// <param name="processingTimeMS">Time the server took to process the request, in milliseconds. (required).</param>
-  public BaseSearchResponse(int hitsPerPage, int nbHits, int nbPages, int page, int processingTimeMS)
+  public BaseSearchResponse(int processingTimeMS)
   {
-    HitsPerPage = hitsPerPage;
-    NbHits = nbHits;
-    NbPages = nbPages;
-    Page = page;
     ProcessingTimeMS = processingTimeMS;
     AdditionalProperties = new Dictionary<string, object>();
   }
@@ -114,13 +106,6 @@ public BaseSearchResponse(int hitsPerPage, int nbHits, int nbPages, int page, in
   [JsonPropertyName("facets_stats")]
   public Dictionary<string, FacetsStats> FacetsStats { get; set; }
 
-  /// <summary>
-  /// Number of hits per page.
-  /// </summary>
-  /// <value>Number of hits per page.</value>
-  [JsonPropertyName("hitsPerPage")]
-  public int HitsPerPage { get; set; }
-
   /// <summary>
   /// Index name used for the query.
   /// </summary>
@@ -142,34 +127,13 @@ public BaseSearchResponse(int hitsPerPage, int nbHits, int nbPages, int page, in
   [JsonPropertyName("message")]
   public string Message { get; set; }
 
-  /// <summary>
-  /// Number of results (hits).
-  /// </summary>
-  /// <value>Number of results (hits).</value>
-  [JsonPropertyName("nbHits")]
-  public int NbHits { get; set; }
-
-  /// <summary>
-  /// Number of pages of results.
-  /// </summary>
-  /// <value>Number of pages of results.</value>
-  [JsonPropertyName("nbPages")]
-  public int NbPages { get; set; }
-
   /// <summary>
   /// Number of hits selected and sorted by the relevant sort algorithm.
   /// </summary>
   /// <value>Number of hits selected and sorted by the relevant sort algorithm.</value>
   [JsonPropertyName("nbSortedHits")]
   public int? NbSortedHits { get; set; }
 
-  /// <summary>
-  /// Page of search results to retrieve.
-  /// </summary>
-  /// <value>Page of search results to retrieve.</value>
-  [JsonPropertyName("page")]
-  public int Page { get; set; }
-
   /// <summary>
   /// Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
   /// </summary>
@@ -262,14 +226,10 @@ public override string ToString()
     sb.Append("  ExhaustiveTypo: ").Append(ExhaustiveTypo).Append("\n");
     sb.Append("  Facets: ").Append(Facets).Append("\n");
     sb.Append("  FacetsStats: ").Append(FacetsStats).Append("\n");
-    sb.Append("  HitsPerPage: ").Append(HitsPerPage).Append("\n");
     sb.Append("  Index: ").Append(Index).Append("\n");
     sb.Append("  IndexUsed: ").Append(IndexUsed).Append("\n");
     sb.Append("  Message: ").Append(Message).Append("\n");
-    sb.Append("  NbHits: ").Append(NbHits).Append("\n");
-    sb.Append("  NbPages: ").Append(NbPages).Append("\n");
     sb.Append("  NbSortedHits: ").Append(NbSortedHits).Append("\n");
-    sb.Append("  Page: ").Append(Page).Append("\n");
     sb.Append("  ParsedQuery: ").Append(ParsedQuery).Append("\n");
     sb.Append("  ProcessingTimeMS: ").Append(ProcessingTimeMS).Append("\n");
     sb.Append("  ProcessingTimingsMS: ").Append(ProcessingTimingsMS).Append("\n");
@@ -317,14 +277,10 @@ public override bool Equals(object obj)
         (ExhaustiveTypo == input.ExhaustiveTypo || ExhaustiveTypo.Equals(input.ExhaustiveTypo)) &&
         (Facets == input.Facets || Facets != null && input.Facets != null && Facets.SequenceEqual(input.Facets)) &&
         (FacetsStats == input.FacetsStats || FacetsStats != null && input.FacetsStats != null && FacetsStats.SequenceEqual(input.FacetsStats)) &&
-        (HitsPerPage == input.HitsPerPage || HitsPerPage.Equals(input.HitsPerPage)) &&
         (Index == input.Index || (Index != null && Index.Equals(input.Index))) &&
         (IndexUsed == input.IndexUsed || (IndexUsed != null && IndexUsed.Equals(input.IndexUsed))) &&
         (Message == input.Message || (Message != null && Message.Equals(input.Message))) &&
-        (NbHits == input.NbHits || NbHits.Equals(input.NbHits)) &&
-        (NbPages == input.NbPages || NbPages.Equals(input.NbPages)) &&
         (NbSortedHits == input.NbSortedHits || NbSortedHits.Equals(input.NbSortedHits)) &&
-        (Page == input.Page || Page.Equals(input.Page)) &&
         (ParsedQuery == input.ParsedQuery || (ParsedQuery != null && ParsedQuery.Equals(input.ParsedQuery))) &&
         (ProcessingTimeMS == input.ProcessingTimeMS || ProcessingTimeMS.Equals(input.ProcessingTimeMS)) &&
         (ProcessingTimingsMS == input.ProcessingTimingsMS || (ProcessingTimingsMS != null && ProcessingTimingsMS.Equals(input.ProcessingTimingsMS))) &&
@@ -372,7 +328,6 @@ public override int GetHashCode()
       {
         hashCode = (hashCode * 59) + FacetsStats.GetHashCode();
       }
-      hashCode = (hashCode * 59) + HitsPerPage.GetHashCode();
       if (Index != null)
       {
         hashCode = (hashCode * 59) + Index.GetHashCode();
@@ -385,10 +340,7 @@ public override int GetHashCode()
       {
         hashCode = (hashCode * 59) + Message.GetHashCode();
       }
-      hashCode = (hashCode * 59) + NbHits.GetHashCode();
-      hashCode = (hashCode * 59) + NbPages.GetHashCode();
       hashCode = (hashCode * 59) + NbSortedHits.GetHashCode();
-      hashCode = (hashCode * 59) + Page.GetHashCode();
       if (ParsedQuery != null)
       {
         hashCode = (hashCode * 59) + ParsedQuery.GetHashCode();

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

@@ -19,8 +19,15 @@ public partial class GetRecommendationsResponse
   /// <summary>
   /// Initializes a new instance of the GetRecommendationsResponse class.
   /// </summary>
-  public GetRecommendationsResponse()
+  [JsonConstructor]
+  public GetRecommendationsResponse() { }
+  /// <summary>
+  /// Initializes a new instance of the GetRecommendationsResponse class.
+  /// </summary>
+  /// <param name="results">results (required).</param>
+  public GetRecommendationsResponse(List<RecommendationsResults> results)
   {
+    Results = results ?? throw new ArgumentNullException(nameof(results));
   }
 
   /// <summary>