Differentiate between routing values in bodies versus query string (#626

) Signed-off-by: Thomas Farr <[email protected]>
opensearch-project · Oct 18, 2024 · 7855eca · 7855eca
1 parent d2733fe
commit 7855eca
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 22 deletions.
diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml
@@ -3369,7 +3369,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     bulk::query.timeout:
       in: query
@@ -3456,7 +3456,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     bulk_stream::query.timeout:
       in: query
@@ -3628,7 +3628,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     count::query.terminate_after:
       in: query
@@ -3684,7 +3684,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     create::query.timeout:
       in: query
@@ -3762,7 +3762,7 @@ components:
       description: Comma-separated list of specific routing values.
       style: form
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       explode: true
     delete::path.id:
       in: path
@@ -3809,7 +3809,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     delete::query.timeout:
       in: query
@@ -4024,7 +4024,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     delete_by_query::query.scroll:
       in: query
@@ -4262,7 +4262,7 @@ components:
       name: routing
       description: Target the specified primary shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     exists::query.stored_fields:
       in: query
@@ -4358,7 +4358,7 @@ components:
       name: routing
       description: Target the specified primary shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     exists_source::query.version:
       in: query
@@ -4476,7 +4476,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     explain::query.stored_fields:
       in: query
@@ -4596,7 +4596,7 @@ components:
       name: routing
       description: Target the specified primary shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     get::query.stored_fields:
       in: query
@@ -4711,7 +4711,7 @@ components:
       name: routing
       description: Target the specified primary shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     get_source::query.version:
       in: query
@@ -4803,7 +4803,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     index::query.timeout:
       in: query
@@ -4899,7 +4899,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     mget::query.stored_fields:
       in: query
@@ -5105,7 +5105,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     mtermvectors::query.term_statistics:
       in: query
@@ -5609,7 +5609,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     search::query.cancel_after_time_interval:
       in: query
@@ -5852,7 +5852,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     search_template::path.index:
       in: path
@@ -5944,7 +5944,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     search_template::query.scroll:
       in: query
@@ -6049,7 +6049,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     termvectors::query.term_statistics:
       in: query
@@ -6167,7 +6167,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     update::query.timeout:
       in: query
@@ -6379,7 +6379,7 @@ components:
       name: routing
       description: Custom value used to route operations to a specific shard.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       style: form
     update_by_query::query.scroll:
       in: query

diff --git a/spec/namespaces/knn.yaml b/spec/namespaces/knn.yaml
@@ -514,7 +514,7 @@ components:
       description: Comma-separated list of specific routing values.
       style: form
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/Routing'
+        $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString'
       explode: true
     knn.search_models::query.scroll:
       name: scroll

diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml
@@ -389,6 +389,8 @@ components:
     ScrollId:
       type: string
     Routing:
+      type: string
+    RoutingInQueryString:
       oneOf:
         - type: string
         - type: array