fix(specs): add getVersion parameter to getSettings (#5254)

Author: millotp

clients/algoliasearch-client-csharp/algoliasearch/Serializer/EnumConverter.cs

@@ -91,21 +91,21 @@ JsonSerializerOptions options
     switch (type)
     {
       case JsonTokenType.String:
+      {
+        var stringValue = reader.GetString();
+        if (stringValue != null && _stringToEnum.TryGetValue(stringValue, out var enumValue))
         {
-          var stringValue = reader.GetString();
-          if (stringValue != null && _stringToEnum.TryGetValue(stringValue, out var enumValue))
-          {
-            return enumValue;
-          }
-
-          break;
-        }
-      case JsonTokenType.Number:
-        {
-          var numValue = reader.GetInt32();
-          _numberToEnum.TryGetValue(numValue, out var enumValue);
           return enumValue;
         }
+
+        break;
+      }
+      case JsonTokenType.Number:
+      {
+        var numValue = reader.GetInt32();
+        _numberToEnum.TryGetValue(numValue, out var enumValue);
+        return enumValue;
+      }
     }
 
     return default;

clients/algoliasearch-client-csharp/algoliasearch/Utils/QueryStringHelper.cs

@@ -36,18 +36,18 @@ public static string ParameterToString(object obj)
       case bool boolean:
         return boolean ? "true" : "false";
       case ICollection collection:
-        {
-          var entries = new List<string>();
-          foreach (var entry in collection)
-            entries.Add(ParameterToString(entry));
-          return string.Join(",", entries);
-        }
+      {
+        var entries = new List<string>();
+        foreach (var entry in collection)
+          entries.Add(ParameterToString(entry));
+        return string.Join(",", entries);
+      }
       case Enum when HasEnumMemberAttrValue(obj):
         return GetEnumMemberAttrValue(obj);
       case AbstractSchema schema when obj.GetType().IsClass:
-        {
-          return ParameterToString(schema.ActualInstance);
-        }
+      {
+        return ParameterToString(schema.ActualInstance);
+      }
       default:
         return Convert.ToString(obj, CultureInfo.InvariantCulture);
     }

clients/algoliasearch-client-csharp/algoliasearch/Utils/SearchClientExtensions.cs

@@ -1157,7 +1157,7 @@ public async Task<bool> IndexExistsAsync(
   {
     try
     {
-      await GetSettingsAsync(indexName, null, cancellationToken);
+      await GetSettingsAsync(indexName, null, null, cancellationToken);
     }
     catch (AlgoliaApiException ex) when (ex.HttpErrorCode == 404)
     {

specs/search/common/parameters.yml

@@ -32,3 +32,11 @@ userID:
   pattern: '^[a-zA-Z0-9 \-*.]+$'
   description: Unique identifier of the user who makes the search request.
   example: user1
+
+getVersion:
+  name: getVersion
+  description: When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility.
+  in: query
+  schema:
+    type: integer
+    default: 1

specs/search/paths/settings/settings.yml

@@ -9,6 +9,7 @@ get:
   summary: Retrieve index settings
   parameters:
     - $ref: '../../../common/parameters.yml#/IndexName'
+    - $ref: '../../common/parameters.yml#/getVersion'
   responses:
     '200':
       description: OK

tests/CTS/requests/search/getSettings.json

@@ -1,11 +1,15 @@
 [
   {
     "parameters": {
-      "indexName": "cts_e2e_settings"
+      "indexName": "cts_e2e_settings",
+      "getVersion": 2
     },
     "request": {
       "path": "/1/indexes/cts_e2e_settings/settings",
-      "method": "GET"
+      "method": "GET",
+      "queryParameters": {
+        "getVersion": "2"
+      }
     },
     "response": {
       "statusCode": 200,