CHANGELOG.md

3.13.0

• ab623194e feat(specs): add subscriptionAction to ingestion specs (#4587) by @shortcuts

3.12.3

• 92bd911848 chore(scripts): point jira issues to another epic (#4505) by @millotp
• b8918494d0 chore(deps): dependencies 2025-03-03 (#4511) by @algolia-bot
• 97d2722bc9 fix(specs): Increase optionalWords visibility in docs (#4559) by @gazconroy

3.12.2

• ecd6bc4fed chore(deps): dependencies 2025-02-17 (#4459) by @algolia-bot

3.12.1

• 506b8a5636 fix(specs): responseFields description (#4399) by @kai687
• 09e657fa76 fix(specs): add a linter to assert that type is present (#4393) by @millotp

3.12.0

• 5aa57630d6 feat(specs): only use shortname in the source input (#4287) by @millotp
• 1e847f4caf fix(specs): move customRanking and keepDiacriticsOnCharacters to indexSettings (#4324) by @millotp
• 57d528a481 feat(clients): endpoint level timeout part 2 (#4318) by @Fluf22
• 58cc5449f5 fix(specs): optionalFilters additional explanation (#4353) by @kai687
• 3b129e01df fix(specs): ingestion expected and received events type (#4356) by @shortcuts
• 22167b8e68 fix(specs): extend Analytics descriptions (#4360) by @gazconroy
• 5b14906c1e fix(specs): remove the processing outcome (#4359) by @millotp
• 952639f0fb fix(specs): adjust style for banner descriptions (#4362) by @kai687
• b39fb53bbb fix(ruby): rename object_id reserved word to algolia_object_id (#4381) by @millotp
• 83f188d333 feat(specs): rename composition to composition-full (private) and add composition (public) (#4357) by @e-krebs

3.11.0

• b569646304 fix(specs): drop singer from ingestion specs (#4281) by @shortcuts
• b2b5acddab chore(deps): dependencies 2024-12-30 (#4286) by @algolia-bot
• 37223c9779 feat(clients): cleanup after replaceAllObjects failure (#3824) by @millotp
• 47b567fd0d chore(deps): dependencies 2025-01-06 (#4299) by @algolia-bot
• 5328ce8333 feat(specs): add notification settings to tasks (#4297) by @millotp
• 653b4f32c0 fix(ruby): use discriminators for oneOf (#4310) by @millotp
• e7b3898f06 feat(clients): add optionnal scopes to replaceAllObjects (#4296) by @millotp
• 47193ad3d1 chore: revert release (#4314) by @shortcuts

3.10.2

• 0481473fe0 chore: trigger auto close pr (#4250) by @shortcuts
• 2856fa34a3 fix(ruby): Set default hits_per_page for SearchClient#browse_objects using accessor (#4253) by @dtyoung
• bc8939f542 fix(clients): support dict in helpers (#4254) by @shortcuts
• 679a8cdb60 fix(specs): endpoint level timeout for ingestion (#4251) by @shortcuts

3.10.1

• 6fb57f9ba fix(clients): lock version (#4228) by @millotp
• 3f5ceb540 fix(ruby): handle unknown attributes in index_exists (#4231) by @millotp
• cd59f445e fix(specs): enable watcher for push (#4229) by @shortcuts
• baf7d6f4d fix(specs): add ignoreConjugations to AlternativesAsExact (#4230) by @shortcuts

3.10.0

• 866d859f8 fix(specs): different summaries for saveObject/addOrUpdate methods (#4223) by @kai687
• baf16c689 feat(specs): add watch to pushTask ingestion (#4224) by @shortcuts

3.9.0

• 068fdacb5 feat(specs): add info and link about indexing rate limits (#4136) by @kai687
• 9e0235697 fix(specs): nb_api_calls in getLogs response is optional (#4142) by @shortcuts
• 56fd73fb6 chore(deps): dependencies 2024-11-25 (#4145) by @algolia-bot
• b728c5f25 fix(specs): consequence is required when saving rules (#4146) by @shortcuts
• afd94fac8 fix(specs): saveRule response type (#4170) by @shortcuts
• 2325c61b8 feat(clients): allow batch size on objects helper (#4172) by @shortcuts
• aae74cb38 fix(specs): remove SFCC source type (#4190) by @millotp
• b4809e789 fix(ruby): expose static helper (#4191) by @millotp
• 254052857 fix(specs): add sourceType to listTasks (#4193) by @millotp
• 106d64313 feat(generators): allow per-spec timeouts (#4173) by @shortcuts
• 9e1e60f9e chore(deps): dependencies 2024-12-09 (#4197) by @algolia-bot

3.8.2

• f97e44ce0 fix(cts): add tests for HTML error (#4097) by @millotp

3.8.1

• 36d583e35 fix(specs): make the searchParams compatible with v4 (#4108) by @millotp
• 996ba5036 fix(specs): remove private beta endpoint from recommend (#4110) by @shortcuts

3.8.0

• 4c73f4c9a feat(specs): add estimate path and responses (#4057) by @cdhawke
• 39ad05495 feat(specs): update estimate response type (#4101) by @cdhawke

3.7.1

• 801241e12 fix(specs): add secrets payload for updates (#4061) by @shortcuts
• 625421783 fix(clients): update browse iterator (#4058) by @Fluf22

3.7.0

• be40cf61d feat(specs): add secrets authentications to ingestion (#4054) by @shortcuts

3.6.0

• 46ba4b50a fix(ruby): provide default ttl (#4027) by @millotp
• 312d33731 feat(specs): add missing message attribute to GetObjectsResponse [skip-bc] (#4029) by @kombucha
• 32f9f4d16 fix(specs): support synonyms type in camel case [skip-bc] (#4031) by @shortcuts
• 7f5fe6b68 feat(clients): expose waitForTasks to batch helpers [skip-bc] (#4030) by @shortcuts

3.5.4

• 1f36e8f93 fix(specs): results in getObjects is required (#4024) by @shortcuts

3.5.3

• fe2c8440e docs(analytics): constrain pagination only to limit query parameter (#4012) by @febeck

3.5.2

• cd98290fa fix(specs): Typo tolernace on words (#3968) by @gazconroy
• 5866c2954 fix(specs): Add context to hitsPerPage (#3969) by @gazconroy
• 9e73e971c fix(ruby): add helper to add segment to user agent (#3972) by @millotp
• 162dfafa1 fix(clients): escape char in comments (#3973) by @millotp
• 8b879dead fix(specs): alternativesAsExact is plurals and synonyms (#3974) by @gazconroy
• 1a9b95e85 fix(specs): Separators are non-alphanumeric characters (#3978) by @gazconroy
• 519fd9840 fix(specs): multiple clients fixes (#3971) by @shortcuts

3.5.1

• 8b343d2ee fix(ruby): only prefix model by client:: (#3923) by @millotp
• f516d0243 fix(specs): Typos in API descriptions (#3932) by @gazconroy
• ee6c043ef fix(clients): remove all client side validation expect null check (#3936) by @millotp
• 434c99f80 fix(specs): use the read transporter for browse (#3938) by @millotp
• 45d433d0a fix(specs): correct type for banners [skip-bc] (#3939) by @millotp

3.5.0

• ad8e3d224 fix(specs): update analytics and abtesting max pagination query limit (#3696) by @febeck
• bed119166 feat(specs): add support for widgets / banners in search for the csharp client (#3870) by @Kalmar99
• 844e57f35 fix(specs): correct typos is Search API (#3898) by @gazconroy
• f554e09c3 chore: revert and fix release (#3922) by @millotp

3.4.0

• 788483537 chore(clients): add workflow to auto-close PR (#3834) by @shortcuts
• e59dd41d5 fix(specs): API key description will be obfuscated (#3840) by @kai687
• dc28c0268 feat(specs): add recommend batch rules endpoint (#3782) by @raed667

3.3.4

• 022131871 fix(specs): correct query params for ingestion [skip-bc] (#3830) by @millotp

3.3.3

• 1a73994ff fix(specs): recommend remove unsupported query parameters [RECO-2345] [skip-bc] (#3692) by @raed667
• 92438873c fix(specs): remove models from ingestion specs [skip-bc] (#3774) by @shortcuts

3.3.2

• 638058eae fix(specs): update search api specs [skip-bc] (#3760) by @Fluf22
• 08d8ee6de chore(deps): dependencies 2024-09-16 [skip-bc] (#3704) by @algolia-bot

3.3.1

• d4df544d6 fix(specs): remove usage [skip-bc] (#3691) by @kai687
• 46d9d8fd0 feat(specs): add (optional) _automaticInsights to search result (#3688) by @raed667

3.3.0

• 2c65a8d11 feat(clients): helper to switch API key in use (#3616) by @Fluf22
• f126366dc fix(specs): note on Analytics API server (#3650) by @kai687
• 3d02b3164 feat(clients): add helper to check if an index exists (#3646) by @millotp
• a36746d65 fix(specs): note on insights API server (#3649) by @kai687
• 1f53716c6 fix(specs): don't extend $ref objects (#3623) by @kai687

3.2.4

• a9405b168 fix(specs): usage api (#3624) by @kai687
• e3af9554e fix(specs): no links across API specs (#3643) by @kai687

3.2.3

• 3d07a1e4f fix(specs): ignorePlurals can be a boolean string (#3620) by @millotp
• c0675ff6b fix(clients): correly parse usage hosts (#3622) by @shortcuts

3.2.2

• 327e08d4e fix(specs): ingestion push task payload [skip-bc] (#3607) by @shortcuts

3.2.1

• 41f849e41 fix(specs): partial update operation (#3486) by @kai687

3.2.0

• 23a799f0e feat(specs): push source type (#3600) by @shortcuts
• 536fdef01 fix(specs): filter run list by type (#3577) by @millotp
• 9b6dc0b70 docs(specs): update api's length minimum value (#3574) by @Jerska

3.1.1

• 4cbbce55c fix(clients): highlight and snippet results e2e (#3567) by @shortcuts
• 7c7de04ab fix(specs): another wrong link (#3570) by @kai687
• f38a9ef12 chore(specs): breaking change method names mapping table (#3568) by @shortcuts
• 9dedfc90f fix(clients): mention main branch instead of master (#3566) by @shortcuts
• 0e5ffb1e8 fix(specs): broken link (#3559) by @kai687

3.1.0

• d53060d96 feat(specs): add /schedule endpoint (#3350) by @febeck

3.0.2

• 6cfc2d479 chore(specs): update rendered title for search params (#3553) by @shortcuts

3.0.1

• 40c5d47bd fix(specs): delete user token processing time (#3525) by @kai687

3.0.0

New major version released! Browse our documentation

• 22348001a fix(specs): required ingestion search params (#3516) by @shortcuts

3.0.0.beta.16

• 4c052002e feat(specs): recursive snippets and highlights result (#3497) by @shortcuts

3.0.0.beta.15

• 7d2ab99ce feat(specs): add authentications to ingestion transformations (#3494) by @shortcuts

3.0.0.beta.14

• 2c6147ee7 feat(specs): add generate code endpoint to ingestion specs (#3489) by @shortcuts
• 6c62a81a7 fix(specs): ingestion docker task input (#3488) by @shortcuts
• eab2887f8 fix(specs): ingestion search endpoint (#3487) by @shortcuts

3.0.0.beta.13

• ac0cadb8a feat(specs): add transformation copilot to ingestion (#3479) by @Fluf22
• 08a04dec8 fix(specs): ingestion destination reject indexPrefix (#3478) by @shortcuts
• cdd673d33 fix(specs): ingestion destinations and transformations (#3477) by @shortcuts
• b4742be76 fix(clients): move the license to the root (#3457) by @millotp
• e5d14171c fix(specs): dictionary entry for stopwords has type property (#3456) by @kai687
• 7af1e75e9 fix(specs): body is not required in multiple batch request (#3454) by @kai687
• b90bef261 feat(specs): add runSource endpoint (#3453) by @millotp
• 27679b7fd chore(clients): remove mention of GA (#3452) by @millotp

3.0.0.beta.12

• e982ddf0a fix(specs): built-in ops accept also int (#3450) by @kai687
• 9a2e7a837 fix(specs): required prop for dictionaryEntry (#3449) by @kai687
• 41d86ce68 feat(clients): delete unused models (#3445) by @millotp
• e17970142 fix(specs): proper title with linter (#3444) by @millotp
• 8fbbd5ebd fix(specs): getObject return object (#3446) by @millotp
• a35e814ab fix(specs): clarify decompounding limitations (#3227) by @kai687

3.0.0.beta.11

• 3ec5f5f7e feat(specs): add v2 endpoints for ingestion (#3416) by @shortcuts
• 200f07e9c fix(specs): add primary to get settings response (#3415) by @kai687
• 81c15cf5b chore(specs): add eslint rule to avoid cross-references (#3413) by @millotp
• be060a060 fix(specs): remove cross-references of analytics (#3414) by @millotp
• fe6f5edab feat(specs): add v2 endpoints for ingestion (#3410) by @shortcuts
• e3c6b8401 fix(specs): remove cross-specs references (#3412) by @shortcuts
• b0fa5a915 fix(ruby): add more retry error details (#3384) by @otomatik

3.0.0.beta.10

• 280037178 fix(specs): update shopify feature flags (#3380) by @millotp
• a68907d1c feat(clients): add api key helper test (#3338) by @Fluf22
• 31ba7f6d0 fix(specs): recommend non required parameters (#3355) by @shortcuts
• 337eea93e fix(specs): results is required in GetRecommendationsResponse (#3357) by @millotp

3.0.0.beta.9

• a009967f6 fix(specs): browse response required properties (#3348) by @millotp
• 04a799417 fix(specs): ingestion task and transformation (#3347) by @shortcuts
• 83badf20c fix(ruby): add the base64 dependency (#3345) by @millotp
• 586e13a54 fix(ruby): use rubyfmt instead of rubocop (#3334) by @millotp
• dcb1b59dc fix(specs): clarify browse parameters (#3333) by @kai687

3.0.0.beta.8

• 9776cb3ba feat(specs): add redirect to renderingContent (#3296) by @shortcuts

3.0.0.beta.7

• 95e4c1e17 chore(ruby): scope to last commit (#3266) by @shortcuts
• 8e98407c1 fix(clients): update ingestion transformations description and fix taggroups (#3265) by @shortcuts

3.0.0.beta.6

• e5cfcf0c4 feat(clients): generate common LICENSE (#3258) by @shortcuts
• 47dd4bb5b fix(clients): update README snippets and contributing guides (#3257) by @shortcuts
• 7a90e4532 feat(clients): add saveObjects, deleteObjects and partialUpdateObjects helpers (#3180) by @shortcuts
• 5dbdb91e9 fix(specs): virtual is a fetchedIndex props (#3255) by @shortcuts
• 0a6277937 fix(specs): add virtual index settings and update renderingContent (#3254) by @shortcuts
• 536a348f1 fix(clients): chunked batch helper size property consistency (#3253) by @Fluf22

3.0.0.beta.5

• b7ae19f2b feat(specs): add transformations endpoints to ingestion (#3215) by @shortcuts
• a99f796dd fix(specs): update discover endpoint (#3212) by @shortcuts
• c91ca54f2 feat(specs): add validate endpoint (#3087) by @Fluf22
• 36aababfd chore(clients): use the ruff python formatter (#3204) by @millotp
• 9ad5c8cae fix(clients): reduce common tests flakyness (#3205) by @millotp
• 3b4be7a3d feat(ruby): add chunked_batch and replace_all_objects helpers (#3208) by @millotp
• fc1752b6e feat(clients): add chunkedBatch helper for Kotlin and Scala (#3206) by @Fluf22
• a58e88322 feat(clients): add generateSecuredApiKey to java (#3167) by @millotp

3.0.0.beta.4

• b2a464a2b feat(clients): add generate_secured_api_key to ruby (#3166) by @millotp
• de4090789 fix(clients): safer replaceAllObjects + metis compliant (#3164) by @shortcuts

3.0.0.beta.3

• 072c38b9a fix(clients): remove unused models from lite clients (#3159) by @shortcuts
• c7f5de9d4 feat(clients): add waitForAppTask helper (#3158) by @millotp
• 3a97fad1f fix(clients): chunked batch helper (#3154) by @shortcuts
• c251dc87e fix(specs): rankingInfo required properties (#3157) by @millotp
• fd5a312fb feat(specs): add getAppTask endpoint to search (#3156) by @millotp
• cdc866549 fix(specs): dont mention index api keys (#3117) by @kai687

3.0.0.beta.2

• 2b70d9ea5 fix(specs): exhaustiveFacetsCount is not deprecated for sffv (#3089) by @kai687
• 1250c2b3c fix(specs): simplify filter types (#3042) by @millotp

3.0.0.beta.1

• b621988bc feat(specs): promote @kai687 to code owner (#3014) by @Fluf22
• f9877a8ae fix(specs): remove periods on summaries (#3013) by @kai687

3.0.0.alpha.18

• 41121e77e fix(specs): attribute and index names case sensitive (#2990) by @kai687
• 67b0eab89 feat(specs): update shopify source and task inputs (#2987) by @Fluf22
• 60e8e6d68 fix(specs): Personalization API (#2982) by @kai687
• 60322c0b5 fix(specs): a/b testing (#2981) by @kai687

3.0.0.alpha.17

• dabdd0291 fix(specs): recommend api (#2958) by @kai687
• 34e345d48 fix(specs): update documentation for consistency (#2976) by @kai687
• aee3fde96 feat(clients): add usage client (#2960) by @shortcuts
• 0348669d0 feat(specs): add algoliaInsights auth type (#2959) by @jkaho
• 60e23f87a fix(specs): usage api (#2954) by @kai687
• 3e0d0dcc2 fix(specs): crawler api (#2949) by @kai687

3.0.0.alpha.16

• 10e08c9e7 fix(specs): query suggestions api (#2924) by @kai687
• b153b397e fix(specs): ingestion api reference (#2918) by @kai687

3.0.0.alpha.15

• 10c9339c8 fix(specs): more flexible custom methods (#2889) by @damcou

3.0.0.alpha.14

• 7dc719cbe fix(specs): make languages an enum (#2865) by @kai687

3.0.0.alpha.13

• 0f8d4432b feat(specs): insights api reference (#2859) by @kai687
• c324c06bd feat(specs): add ga4BigqueryExport, streaming and append options to task inputs (#2858) by @JasonBerry
• 156fd9e69 feat(specs): improve API reference documentation (#2831) by @kai687

3.0.0.alpha.12

• 234427491 feat(specs): Add MappingInput to Task Inputs (#2787) by @jsok

3.0.0.alpha.11

• a138c2fef fix(specs): add queryID to search response (#2801) by @aallam
• 6f0b00ead chore(specs): remove JSON specs and new worlds logic (#2794) by @shortcuts

3.0.0.alpha.10

• d48e2f624 fix(specs): add missing attributes for CT Source update (#2792) by @damcou
• f3e894002 fix(clients): replace all objects (#2762) by @shortcuts
• 92cd1c793 fix(clients): browse synonyms page not in response (#2757) by @shortcuts

3.0.0.alpha.9

• 4f6e2d0b3 fix(specs): allow custom fields to be nullable (#2746) by @shortcuts

3.0.0.alpha.8

• 6624759e1 feat(specs): add CustomFields to CT Source Input (#2742) by @damcou
• ef37e65b7 fix(clients): add e2e tests for analytics API (#2737) by @millotp

3.0.0.alpha.7

• 28b34ffb6 feat(ruby): add browse helpers (#2669) by @millotp

3.0.0.alpha.6

• 379fbc501 fix(specs): correct searchSynonyms parameters (#2595) by @morganleroi
• 982fd3ca4 feat(specs): import crawler and usage specs from new world repo (#2598) by @shortcuts
• 9532a0136 feat(specs): AB testing tracked user count (#2596) by @cdhawke
• 02302dc36 feat(ruby): add wait helpers (#2577) by @millotp
• 2481e3ac8 fix(clients): support the rest of the languages (#2571) by @millotp
• 99ce6dbae fix(clients): monitoring for JavaScript and Python (#2568) by @shortcuts
• bb822f79a fix(ruby): make the snippets pretty (#2562) by @millotp
• 6c099d46f fix(ruby): correct oneOf deserialization (#2559) by @millotp
• 99e4bdf2c feat(specs): add acl permissions to operations (#2555) by @kai687
• 8b0622380 fix(specs): rename clearAllSynonyms to clearSynonyms (#2553) by @kai687

3.0.0.alpha.5

• 7c5ba3288 feat(specs): update Insights API spec (#2376) by @kai687
• 297baa987 chore(clients): provide snippets for all languages (#2518) by @shortcuts
• 857f3632e feat(clients): generate code snippets from cts (#2511) by @shortcuts
• 7085d099e fix(ruby): exclude vendor from bundled gem (#2512) by @millotp

3.0.0.alpha.4

• b4ca09335 fix(ruby): release using Trusted Publishing (#2504) by @millotp

3.0.0.alpha.3

• ae20258c6 feat(clients): deserialize in e2e and SFFV response (#2500) by @shortcuts
• 4dc28da98 chore(clients): add more e2e (#2497) by @shortcuts

3.0.0.alpha.2

• ae6adfbf7 fix(specs): port recommend changes (#2476) by @shortcuts

3.0.0.alpha.1

• 9f4f17585 fix(ruby): support ruby alpha format (#2447) by @millotp
• 443c8909a chore(ruby): setup release (#2446) by @millotp
• 1281c2d10 feat(ruby): client tests (#2445) by @millotp
• e0527a573 feat(ruby): e2e CTS (#2439) by @millotp
• 48c33a77e feat(ruby): add CTS (#2401) by @millotp
• 916789e10 fix(ruby): support additionalProperties: true (#2418) by @millotp
• c0279405d fix(ruby): customize linter (#2409) by @millotp
• 77b7a8ca8 feat(ruby): make hit generic (#2400) by @millotp
• 1e7c50d2f feat(ruby): retry strategy (#2383) by @millotp
• 614d56ae8 fix(ruby): make the playground work (#2379) by @millotp
• 8d71c2b69 fix(specs): provide non clashing names for custom methods (#2369) by @shortcuts
• 205519c6f fix(specs): highlight result map definition (#2312) by @shortcuts
• a8f2565a0 fix(ruby): add libraries in the Dockerfile (#2333) by @millotp
• b97259611 chore(ruby): fix renovate config (#2314) by @shortcuts
• 833b489d1 feat(ruby): setup client (#2311) by @millotp