allow unknow query paramters for ui settings route (#8152) (#8158)

(cherry picked from commit ba8c50b) Signed-off-by: Hailong Cui <ihailong@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Sep 12, 2024 · 30a49b2 · 30a49b2
1 parent a87ce21
commit 30a49b2
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 20 deletions.
diff --git a/src/core/server/ui_settings/routes/delete.ts b/src/core/server/ui_settings/routes/delete.ts
@@ -39,11 +39,14 @@ const validate = {
   params: schema.object({
     key: schema.string(),
   }),
-  query: schema.object({
-    scope: schema.maybe(
-      schema.oneOf([schema.literal(UiSettingScope.GLOBAL), schema.literal(UiSettingScope.USER)])
-    ),
-  }),
+  query: schema.object(
+    {
+      scope: schema.maybe(
+        schema.oneOf([schema.literal(UiSettingScope.GLOBAL), schema.literal(UiSettingScope.USER)])
+      ),
+    },
+    { unknowns: 'allow' }
+  ),
 };
 
 export function registerDeleteRoute(router: IRouter) {

diff --git a/src/core/server/ui_settings/routes/get.ts b/src/core/server/ui_settings/routes/get.ts
@@ -35,11 +35,14 @@ import { SavedObjectsErrorHelpers } from '../../saved_objects';
 import { UiSettingScope } from '../types';
 
 const validate = {
-  query: schema.object({
-    scope: schema.maybe(
-      schema.oneOf([schema.literal(UiSettingScope.GLOBAL), schema.literal(UiSettingScope.USER)])
-    ),
-  }),
+  query: schema.object(
+    {
+      scope: schema.maybe(
+        schema.oneOf([schema.literal(UiSettingScope.GLOBAL), schema.literal(UiSettingScope.USER)])
+      ),
+    },
+    { unknowns: 'allow' }
+  ),
 };
 
 export function registerGetRoute(router: IRouter) {

diff --git a/src/core/server/ui_settings/routes/set.ts b/src/core/server/ui_settings/routes/set.ts
@@ -42,11 +42,14 @@ const validate = {
   body: schema.object({
     value: schema.any(),
   }),
-  query: schema.object({
-    scope: schema.maybe(
-      schema.oneOf([schema.literal(UiSettingScope.GLOBAL), schema.literal(UiSettingScope.USER)])
-    ),
-  }),
+  query: schema.object(
+    {
+      scope: schema.maybe(
+        schema.oneOf([schema.literal(UiSettingScope.GLOBAL), schema.literal(UiSettingScope.USER)])
+      ),
+    },
+    { unknowns: 'allow' }
+  ),
 };
 
 export function registerSetRoute(router: IRouter) {

diff --git a/src/core/server/ui_settings/routes/set_many.ts b/src/core/server/ui_settings/routes/set_many.ts
@@ -39,11 +39,14 @@ const validate = {
   body: schema.object({
     changes: schema.object({}, { unknowns: 'allow' }),
   }),
-  query: schema.object({
-    scope: schema.maybe(
-      schema.oneOf([schema.literal(UiSettingScope.GLOBAL), schema.literal(UiSettingScope.USER)])
-    ),
-  }),
+  query: schema.object(
+    {
+      scope: schema.maybe(
+        schema.oneOf([schema.literal(UiSettingScope.GLOBAL), schema.literal(UiSettingScope.USER)])
+      ),
+    },
+    { unknowns: 'allow' }
+  ),
 };
 
 export function registerSetManyRoute(router: IRouter) {