Merge branch 'main' into feat/ci-push-to-algolia-web

Author: shortcuts

.gitignore

@@ -58,5 +58,3 @@ pubspec.lock
 swiftformat
 
 foo
-
-/snippets

clients/algoliasearch-client-ruby/lib/algolia/api/monitoring_client.rb

@@ -489,7 +489,7 @@ def get_reachability_with_http_info(clusters, request_options = {})
     # @return [Hash<String, Hash>]
     def get_reachability(clusters, request_options = {})
       response = get_reachability_with_http_info(clusters, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Monitoring::Hash<String, Hash>")
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Hash<String, Hash>")
     end
 
     # Retrieves the servers that belong to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application&#39;s cluster.  - Without authentication, the response lists the servers for all Algolia clusters.

clients/algoliasearch-client-ruby/lib/algolia/api/search_client.rb

@@ -1245,7 +1245,7 @@ def get_dictionary_languages_with_http_info(request_options = {})
     # @return [Hash<String, Languages>]
     def get_dictionary_languages(request_options = {})
       response = get_dictionary_languages_with_http_info(request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::Hash<String, Languages>")
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Hash<String, Languages>")
     end
 
     # Retrieves the languages for which standard dictionary entries are turned off.
@@ -1400,7 +1400,7 @@ def get_object_with_http_info(index_name, object_id, attributes_to_retrieve = ni
     # @return [Object]
     def get_object(index_name, object_id, attributes_to_retrieve = nil, request_options = {})
       response = get_object_with_http_info(index_name, object_id, attributes_to_retrieve, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::Object")
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
     # Retrieves one or more records, potentially from different indices.  Records are returned in the same order as the requests.

clients/algoliasearch-client-swift/.github/workflows/release.yml

@@ -15,12 +15,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Get versions
-        id: versions
-        shell: bash
-        run: |
-          echo "RELEASE_VERSION=$(grep "s.version = " AlgoliaSearchClient.podspec | cut -d "'" -f2)" >> $GITHUB_OUTPUT
-
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -30,13 +24,6 @@ jobs:
       - name: Install CocoaPods
         run: gem install cocoapods
 
-      - name: Publish release on Github
-        run: |
-          set -eo pipefail
-          gh release create ${{ steps.versions.outputs.RELEASE_VERSION }} --title ${{ steps.versions.outputs.RELEASE_VERSION }} -F CHANGELOG.md --target ${{ github.sha }}
-        env:
-          GH_TOKEN: ${{ github.token }}
-
       - name: Publish on CocoaPods
         run: |
           set -eo pipefail

config/generation.config.mjs

@@ -4,7 +4,10 @@ export const patterns = [
   'specs/bundled/*.json',
 
   'clients/**',
-  'guides/**',
+  'docs/**',
+  'docs/**/.*',
+  'docs/**/.*/**',
+  '!docs/README.md',
   '!clients/README.md',
   '!clients/**/.openapi-generator-ignore',
   'clients/**/.github/**',
@@ -22,8 +25,6 @@ export const patterns = [
   '!clients/algoliasearch-client-csharp/algoliasearch/Models/Common/**',
 
   'tests/output/csharp/global.json',
-  'guides/csharp/.config/**',
-  'guides/csharp/.gitignore',
 
   // Dart
   '!clients/algoliasearch-client-dart/**',
@@ -49,7 +50,6 @@ export const patterns = [
   '!clients/algoliasearch-client-go/algolia/utils/*',
 
   '!tests/output/go/go.*',
-  'guides/go/.golangci.yml',
 
   // Java
   '!clients/algoliasearch-client-java/**',
@@ -136,9 +136,6 @@ export const patterns = [
   '!clients/algoliasearch-client-scala/src/main/scala/algoliasearch/config/**',
   '!clients/algoliasearch-client-scala/src/main/scala/algoliasearch/extension/**',
 
-  'guides/scala/.scalafmt.conf',
-  'guides/scala/.gitignore',
-
   // Swift
   'clients/algoliasearch-client-swift/**',
   '!clients/algoliasearch-client-swift/*',
@@ -154,8 +151,6 @@ export const patterns = [
   'tests/output/swift/Package.swift',
   '!tests/output/swift/manual/**',
   '!tests/output/swift/Utils/**',
-  'guides/.gitignore',
-  'guides/swift/.swiftformat',
 
   'clients/**/LICENSE',
 

docs/README.md

@@ -0,0 +1,3 @@
+## docs
+
+This folder contains generated code snippets and guides for the API clients, you can see them used on [the Algolia documentation](https://www.algolia.com/doc/libraries)

guides/abtesting-snippets.json renamed to docs/bundled/abtesting-snippets.json

@@ -292,7 +292,7 @@
       "default": "require \"algolia\""
     },
     "addABTests": {
-      "default": "response = client.add_ab_tests(\n  AddABTestsRequest.new(\n    end_at: \"2022-12-31T00:00:00.000Z\",\n    name: \"myABTest\",\n    variants: [\n      AbTestsVariant.new(index: \"AB_TEST_1\", traffic_percentage: 30),\n      AbTestsVariant.new(index: \"AB_TEST_2\", traffic_percentage: 50)\n    ]\n  )\n)"
+      "default": "response = client.add_ab_tests(\n  Algolia::Abtesting::AddABTestsRequest.new(\n    end_at: \"2022-12-31T00:00:00.000Z\",\n    name: \"myABTest\",\n    variants: [\n      Algolia::Abtesting::AbTestsVariant.new(index: \"AB_TEST_1\", traffic_percentage: 30),\n      Algolia::Abtesting::AbTestsVariant.new(index: \"AB_TEST_2\", traffic_percentage: 50)\n    ]\n  )\n)"
     },
     "customDelete": {
       "default": "response = client.custom_delete(\"test/minimal\")"
@@ -316,7 +316,7 @@
       "default": "response = client.list_ab_tests"
     },
     "scheduleABTest": {
-      "default": "response = client.schedule_ab_test(\n  ScheduleABTestsRequest.new(\n    end_at: \"2022-12-31T00:00:00.000Z\",\n    scheduled_at: \"2022-11-31T00:00:00.000Z\",\n    name: \"myABTest\",\n    variants: [\n      AbTestsVariant.new(index: \"AB_TEST_1\", traffic_percentage: 30),\n      AbTestsVariant.new(index: \"AB_TEST_2\", traffic_percentage: 50)\n    ]\n  )\n)"
+      "default": "response = client.schedule_ab_test(\n  Algolia::Abtesting::ScheduleABTestsRequest.new(\n    end_at: \"2022-12-31T00:00:00.000Z\",\n    scheduled_at: \"2022-11-31T00:00:00.000Z\",\n    name: \"myABTest\",\n    variants: [\n      Algolia::Abtesting::AbTestsVariant.new(index: \"AB_TEST_1\", traffic_percentage: 30),\n      Algolia::Abtesting::AbTestsVariant.new(index: \"AB_TEST_2\", traffic_percentage: 50)\n    ]\n  )\n)"
     },
     "setClientApiKey": {
       "default": "client.set_client_api_key(\"updated-api-key\")"

guides/analytics-snippets.json renamed to docs/bundled/analytics-snippets.json

@@ -1279,22 +1279,22 @@
       "default": "require \"algolia\""
     },
     "createAuthentication": {
-      "default": "response = client.create_authentication(\n  AuthenticationCreate.new(\n    type: \"oauth\",\n    name: \"authName\",\n    input: AuthOAuth.new(url: \"http://test.oauth\", client_id: \"myID\", client_secret: \"mySecret\")\n  )\n)"
+      "default": "response = client.create_authentication(\n  Algolia::Ingestion::AuthenticationCreate.new(\n    type: \"oauth\",\n    name: \"authName\",\n    input: Algolia::Ingestion::AuthOAuth.new(url: \"http://test.oauth\", client_id: \"myID\", client_secret: \"mySecret\")\n  )\n)"
     },
     "createDestination": {
-      "default": "response = client.create_destination(\n  DestinationCreate.new(\n    type: \"search\",\n    name: \"destinationName\",\n    input: DestinationIndexName.new(index_name: \"<YOUR_INDEX_NAME>\"),\n    authentication_id: \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\"\n  )\n)"
+      "default": "response = client.create_destination(\n  Algolia::Ingestion::DestinationCreate.new(\n    type: \"search\",\n    name: \"destinationName\",\n    input: Algolia::Ingestion::DestinationIndexName.new(index_name: \"<YOUR_INDEX_NAME>\"),\n    authentication_id: \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\"\n  )\n)"
     },
     "createSource": {
-      "default": "response = client.create_source(\n  SourceCreate.new(\n    type: \"commercetools\",\n    name: \"sourceName\",\n    input: SourceCommercetools.new(\n      store_keys: [\"myStore\"],\n      locales: [\"de\"],\n      url: \"http://commercetools.com\",\n      project_key: \"keyID\"\n    ),\n    authentication_id: \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\"\n  )\n)"
+      "default": "response = client.create_source(\n  Algolia::Ingestion::SourceCreate.new(\n    type: \"commercetools\",\n    name: \"sourceName\",\n    input: Algolia::Ingestion::SourceCommercetools.new(\n      store_keys: [\"myStore\"],\n      locales: [\"de\"],\n      url: \"http://commercetools.com\",\n      project_key: \"keyID\"\n    ),\n    authentication_id: \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\"\n  )\n)"
     },
     "createTask": {
-      "default": "response = client.create_task(\n  TaskCreate.new(source_id: \"search\", destination_id: \"destinationName\", action: \"replace\")\n)"
+      "default": "response = client.create_task(\n  Algolia::Ingestion::TaskCreate.new(source_id: \"search\", destination_id: \"destinationName\", action: \"replace\")\n)"
     },
     "createTaskV1": {
-      "default": "response = client.create_task_v1(\n  TaskCreateV1.new(\n    source_id: \"search\",\n    destination_id: \"destinationName\",\n    trigger: OnDemandTriggerInput.new(type: \"onDemand\"),\n    action: \"replace\"\n  )\n)"
+      "default": "response = client.create_task_v1(\n  Algolia::Ingestion::TaskCreateV1.new(\n    source_id: \"search\",\n    destination_id: \"destinationName\",\n    trigger: Algolia::Ingestion::OnDemandTriggerInput.new(type: \"onDemand\"),\n    action: \"replace\"\n  )\n)"
     },
     "createTransformation": {
-      "default": "response = client.create_transformation(TransformationCreate.new(code: \"foo\", name: \"bar\", description: \"baz\"))"
+      "default": "response = client.create_transformation(\n  Algolia::Ingestion::TransformationCreate.new(code: \"foo\", name: \"bar\", description: \"baz\")\n)"
     },
     "customDelete": {
       "default": "response = client.custom_delete(\"test/minimal\")"
@@ -1387,10 +1387,10 @@
       "default": "response = client.list_transformations"
     },
     "pushTask": {
-      "default": "response = client.push_task(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  PushTaskPayload.new(\n    action: \"addObject\",\n    records: [\n      PushTaskRecords.new(key: \"bar\", foo: \"1\", object_id: \"o\"),\n      PushTaskRecords.new(key: \"baz\", foo: \"2\", object_id: \"k\")\n    ]\n  )\n)"
+      "default": "response = client.push_task(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  Algolia::Ingestion::PushTaskPayload.new(\n    action: \"addObject\",\n    records: [\n      Algolia::Ingestion::PushTaskRecords.new(key: \"bar\", foo: \"1\", object_id: \"o\"),\n      Algolia::Ingestion::PushTaskRecords.new(key: \"baz\", foo: \"2\", object_id: \"k\")\n    ]\n  )\n)"
     },
     "runSource": {
-      "default": "response = client.run_source(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  RunSourcePayload.new(\n    index_to_include: [\"products_us\", \"products eu\"],\n    entity_ids: [\"1234\", \"5678\"],\n    entity_type: \"product\"\n  )\n)"
+      "default": "response = client.run_source(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  Algolia::Ingestion::RunSourcePayload.new(\n    index_to_include: [\"products_us\", \"products eu\"],\n    entity_ids: [\"1234\", \"5678\"],\n    entity_type: \"product\"\n  )\n)"
     },
     "runTask": {
       "default": "response = client.run_task(\"6c02aeb1-775e-418e-870b-1faccd4b2c0f\")"
@@ -1399,22 +1399,22 @@
       "default": "response = client.run_task_v1(\"6c02aeb1-775e-418e-870b-1faccd4b2c0f\")"
     },
     "searchAuthentications": {
-      "default": "response = client.search_authentications(\n  AuthenticationSearch.new(\n    authentication_ids: [\"6c02aeb1-775e-418e-870b-1faccd4b2c0f\", \"947ac9c4-7e58-4c87-b1e7-14a68e99699a\"]\n  )\n)"
+      "default": "response = client.search_authentications(\n  Algolia::Ingestion::AuthenticationSearch.new(\n    authentication_ids: [\"6c02aeb1-775e-418e-870b-1faccd4b2c0f\", \"947ac9c4-7e58-4c87-b1e7-14a68e99699a\"]\n  )\n)"
     },
     "searchDestinations": {
-      "default": "response = client.search_destinations(\n  DestinationSearch.new(\n    destination_ids: [\"6c02aeb1-775e-418e-870b-1faccd4b2c0f\", \"947ac9c4-7e58-4c87-b1e7-14a68e99699a\"]\n  )\n)"
+      "default": "response = client.search_destinations(\n  Algolia::Ingestion::DestinationSearch.new(\n    destination_ids: [\"6c02aeb1-775e-418e-870b-1faccd4b2c0f\", \"947ac9c4-7e58-4c87-b1e7-14a68e99699a\"]\n  )\n)"
     },
     "searchSources": {
-      "default": "response = client.search_sources(\n  SourceSearch.new(source_ids: [\"6c02aeb1-775e-418e-870b-1faccd4b2c0f\", \"947ac9c4-7e58-4c87-b1e7-14a68e99699a\"])\n)"
+      "default": "response = client.search_sources(\n  Algolia::Ingestion::SourceSearch.new(\n    source_ids: [\"6c02aeb1-775e-418e-870b-1faccd4b2c0f\", \"947ac9c4-7e58-4c87-b1e7-14a68e99699a\"]\n  )\n)"
     },
     "searchTasks": {
-      "default": "response = client.search_tasks(\n  TaskSearch.new(\n    task_ids: [\n      \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n      \"947ac9c4-7e58-4c87-b1e7-14a68e99699a\",\n      \"76ab4c2a-ce17-496f-b7a6-506dc59ee498\"\n    ]\n  )\n)"
+      "default": "response = client.search_tasks(\n  Algolia::Ingestion::TaskSearch.new(\n    task_ids: [\n      \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n      \"947ac9c4-7e58-4c87-b1e7-14a68e99699a\",\n      \"76ab4c2a-ce17-496f-b7a6-506dc59ee498\"\n    ]\n  )\n)"
     },
     "searchTasksV1": {
-      "default": "response = client.search_tasks_v1(\n  TaskSearch.new(\n    task_ids: [\n      \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n      \"947ac9c4-7e58-4c87-b1e7-14a68e99699a\",\n      \"76ab4c2a-ce17-496f-b7a6-506dc59ee498\"\n    ]\n  )\n)"
+      "default": "response = client.search_tasks_v1(\n  Algolia::Ingestion::TaskSearch.new(\n    task_ids: [\n      \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n      \"947ac9c4-7e58-4c87-b1e7-14a68e99699a\",\n      \"76ab4c2a-ce17-496f-b7a6-506dc59ee498\"\n    ]\n  )\n)"
     },
     "searchTransformations": {
-      "default": "response = client.search_transformations(\n  TransformationSearch.new(\n    transformation_ids: [\n      \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n      \"947ac9c4-7e58-4c87-b1e7-14a68e99699a\",\n      \"76ab4c2a-ce17-496f-b7a6-506dc59ee498\"\n    ]\n  )\n)"
+      "default": "response = client.search_transformations(\n  Algolia::Ingestion::TransformationSearch.new(\n    transformation_ids: [\n      \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n      \"947ac9c4-7e58-4c87-b1e7-14a68e99699a\",\n      \"76ab4c2a-ce17-496f-b7a6-506dc59ee498\"\n    ]\n  )\n)"
     },
     "setClientApiKey": {
       "default": "client.set_client_api_key(\"updated-api-key\")"
@@ -1423,34 +1423,34 @@
       "default": "response = client.trigger_docker_source_discover(\"6c02aeb1-775e-418e-870b-1faccd4b2c0f\")"
     },
     "tryTransformation": {
-      "default": "response = client.try_transformation(TransformationTry.new(code: \"foo\", sample_record: {bar: \"baz\"}))"
+      "default": "response = client.try_transformation(\n  Algolia::Ingestion::TransformationTry.new(code: \"foo\", sample_record: {bar: \"baz\"})\n)"
     },
     "tryTransformationBeforeUpdate": {
-      "default": "response = client.try_transformation_before_update(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  TransformationTry.new(code: \"foo\", sample_record: {bar: \"baz\"})\n)"
+      "default": "response = client.try_transformation_before_update(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  Algolia::Ingestion::TransformationTry.new(code: \"foo\", sample_record: {bar: \"baz\"})\n)"
     },
     "updateAuthentication": {
-      "default": "response = client.update_authentication(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  AuthenticationUpdate.new(name: \"newName\")\n)"
+      "default": "response = client.update_authentication(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  Algolia::Ingestion::AuthenticationUpdate.new(name: \"newName\")\n)"
     },
     "updateDestination": {
-      "default": "response = client.update_destination(\"6c02aeb1-775e-418e-870b-1faccd4b2c0f\", DestinationUpdate.new(name: \"newName\"))"
+      "default": "response = client.update_destination(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  Algolia::Ingestion::DestinationUpdate.new(name: \"newName\")\n)"
     },
     "updateSource": {
-      "default": "response = client.update_source(\"6c02aeb1-775e-418e-870b-1faccd4b2c0f\", SourceUpdate.new(name: \"newName\"))"
+      "default": "response = client.update_source(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  Algolia::Ingestion::SourceUpdate.new(name: \"newName\")\n)"
     },
     "updateTask": {
-      "default": "response = client.update_task(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  TaskUpdate.new(enabled: false, cron: \"* * * * *\")\n)"
+      "default": "response = client.update_task(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  Algolia::Ingestion::TaskUpdate.new(enabled: false, cron: \"* * * * *\")\n)"
     },
     "updateTaskV1": {
-      "default": "response = client.update_task_v1(\"6c02aeb1-775e-418e-870b-1faccd4b2c0f\", TaskUpdateV1.new(enabled: false))"
+      "default": "response = client.update_task_v1(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  Algolia::Ingestion::TaskUpdateV1.new(enabled: false)\n)"
     },
     "updateTransformation": {
-      "default": "response = client.update_transformation(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  TransformationCreate.new(code: \"foo\", name: \"bar\", description: \"baz\")\n)"
+      "default": "response = client.update_transformation(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  Algolia::Ingestion::TransformationCreate.new(code: \"foo\", name: \"bar\", description: \"baz\")\n)"
     },
     "validateSource": {
-      "default": "response = client.validate_source(\n  SourceCreate.new(\n    type: \"commercetools\",\n    name: \"sourceName\",\n    input: SourceCommercetools.new(\n      store_keys: [\"myStore\"],\n      locales: [\"de\"],\n      url: \"http://commercetools.com\",\n      project_key: \"keyID\"\n    ),\n    authentication_id: \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\"\n  )\n)"
+      "default": "response = client.validate_source(\n  Algolia::Ingestion::SourceCreate.new(\n    type: \"commercetools\",\n    name: \"sourceName\",\n    input: Algolia::Ingestion::SourceCommercetools.new(\n      store_keys: [\"myStore\"],\n      locales: [\"de\"],\n      url: \"http://commercetools.com\",\n      project_key: \"keyID\"\n    ),\n    authentication_id: \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\"\n  )\n)"
     },
     "validateSourceBeforeUpdate": {
-      "default": "response = client.validate_source_before_update(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  SourceUpdate.new(name: \"newName\")\n)"
+      "default": "response = client.validate_source_before_update(\n  \"6c02aeb1-775e-418e-870b-1faccd4b2c0f\",\n  Algolia::Ingestion::SourceUpdate.new(name: \"newName\")\n)"
     },
     "init": {
       "default": "client = Algolia::IngestionClient.create(\"ALGOLIA_APPLICATION_ID\", \"ALGOLIA_API_KEY\", \"ALGOLIA_APPLICATION_REGION\")"