[SCAL-233077] add user_preference property in report export apis

thoughtspot · Nov 20, 2024 · c7486f1 · c7486f1
1 parent bdcd400
commit c7486f1
Showing 1 changed file with 41 additions and 0 deletions.
diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json
@@ -1724,6 +1724,14 @@
                   "runtime_param_override": {
                     "description": "JSON object for setting values of parameters at runtime. For example, <code> {\"param1\": \"Double List Param\", \"paramVal1\": 0.5}</code>. You can add multiple keys by incrementing the number at the end, for example, param2, paramVal2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_parameters).",
                     "type": "object"
+                  },
+                  "regional_settings": {
+                    "description": "Options for specific region speciic overrides to support date/number/string/currency formatting.",
+                    "allOf": [
+                      {
+                        "$ref": "#/components/schemas/RegionalSettingsInput"
+                      }
+                    ]
                   }
                 },
                 "required": [
@@ -1834,6 +1842,14 @@
                   "runtime_param_override": {
                     "description": "JSON object for setting values of parameters in runtime.",
                     "type": "object"
+                  },
+                  "regional_settings": {
+                    "description": "Options for specific region speciic overrides to support date/number/string/currency formatting.",
+                    "allOf": [
+                      {
+                        "$ref": "#/components/schemas/RegionalSettingsInput"
+                      }
+                    ]
                   }
                 }
               }
@@ -13224,6 +13240,31 @@
           }
         }
       },
+      "RegionalSettingsInput": {
+        "type": "object",
+        "properties": {
+          "currency": {
+            "type": "string",
+            "description": "ISO code to be appended with currency values.",
+            "nullable": true
+          },
+          "user_locale": {
+            "type": "string",
+            "description": "Indicates the locale to be used for all formatting.",
+            "nullable": true
+          },
+          "number_locale": {
+            "type": "string",
+            "description": "Indicates the locale to be used for number formatting.",
+            "nullable": true
+          },
+          "date_locale": {
+            "type": "string",
+            "description": "Indicates the locale to be used for date formatting.",
+            "nullable": true
+          }
+        }
+      },
       "PermissionOfPrincipalsResponse": {
         "type": "object",
         "properties": {