Skip to content

Conversation

millotp
Copy link
Collaborator

@millotp millotp commented Aug 21, 2025

🧭 What and Why

🎟 JIRA Ticket: CR-9310

Add the getVersion query parameter to getSettings.
This was removed in https://github.com/algolia/doc/pull/7793, but is still useful for the Dashboard.

Original description of this parameter:

#### Backward compatibility

Synonyms were originally set via the index settings,
and a [Get settings](#get-settings) call would return all synonyms as part of the settings JSON data.

This behavior is still available to maintain backward compatibility.
If you don't want to include synonyms in your settings, add `getVersion=2` to your request as a query parameter:

`GET /1/indexes/{indexName}/settings?getVersion=2`

Until you switch to this new Synonyms API, you can still manage your synonyms via the index settings.

@millotp millotp self-assigned this Aug 21, 2025
@millotp millotp requested a review from a team as a code owner August 21, 2025 14:14
@millotp millotp requested review from morganleroi and Fluf22 August 21, 2025 14:14
@algolia-bot
Copy link
Collaborator

algolia-bot commented Aug 21, 2025

✔️ Code generated!

Name Link
🪓 Triggered by 630c0a87a3867b32e849882c71238958c2e5d104
🍃 Generated commit 8840291a768f08e85ff6cdbed9bcd7e76f72a52d
🌲 Generated branch generated/fix/get-version
📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language Req/s
go 1754
javascript 1612
php 1494
csharp 1289
python 1135
java 982
ruby 840
swift 393
scala 23

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants