rest: only show field with custom sharding method

coszio · coszio · commit 71486c1e7e1a · 2025-11-28T18:11:39.000-03:00
diff --git a/docs/redoc/master/openapi.json b/docs/redoc/master/openapi.json
@@ -16007,15 +16007,14 @@
       },
       "ShardKeysResponse": {
         "type": "object",
-        "required": [
-          "shard_keys"
-        ],
         "properties": {
           "shard_keys": {
+            "description": "The existing shard keys. Only available when sharding method is `custom`",
             "type": "array",
             "items": {
               "$ref": "#/components/schemas/ShardKeyDescription"
-            }
+            },
+            "nullable": true
           }
         }
       },
diff --git a/lib/api/src/grpc/conversions.rs b/lib/api/src/grpc/conversions.rs
@@ -134,6 +134,7 @@ impl From<(Instant, ShardKeysResponse)> for ListShardKeysResponse {
         let ShardKeysResponse { shard_keys } = response;
         let shard_keys = shard_keys
             .into_iter()
+            .flatten()
             .map(|key_desc| {
                 let key = Some(convert_shard_key_to_grpc(key_desc.key));
                 ShardKeyDescription { key }
diff --git a/lib/api/src/rest/models.rs b/lib/api/src/rest/models.rs
@@ -171,5 +171,7 @@ pub struct ShardKeyDescription {
 #[derive(Debug, Serialize, JsonSchema)]
 #[serde(rename_all = "snake_case")]
 pub struct ShardKeysResponse {
-    pub shard_keys: Vec<ShardKeyDescription>,
+    /// The existing shard keys. Only available when sharding method is `custom`
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub shard_keys: Option<Vec<ShardKeyDescription>>,
 }
diff --git a/src/common/collections.rs b/src/common/collections.rs
@@ -100,11 +100,16 @@ pub async fn do_get_collection_shard_keys(
     let collection = toc.get_collection(&collection_pass).await?;
 
     let state = collection.state().await;
-    let shard_keys = state
-        .shards_key_mapping
-        .iter_shard_keys()
-        .map(|k| ShardKeyDescription { key: k.clone() })
-        .collect();
+    let shard_keys = match state.config.params.sharding_method.unwrap_or_default() {
+        ShardingMethod::Auto => None,
+        ShardingMethod::Custom => Some(
+            state
+                .shards_key_mapping
+                .iter_shard_keys()
+                .map(|k| ShardKeyDescription { key: k.clone() })
+                .collect(),
+        ),
+    };
 
     Ok(ShardKeysResponse { shard_keys })
 }

Original file line number	Diff line number	Diff line change
`@@ -171,5 +171,7 @@ pub struct ShardKeyDescription {`
`171`	`171`	`#[derive(Debug, Serialize, JsonSchema)]`
`172`	`172`	`#[serde(rename_all = "snake_case")]`
`173`	`173`	`pub struct ShardKeysResponse {`
`174`		`- pub shard_keys: Vec<ShardKeyDescription>,`
	`174`	+ /// The existing shard keys. Only available when sharding method is `custom`
	`175`	`+ #[serde(skip_serializing_if = "Option::is_none")]`
	`176`	`+ pub shard_keys: Option<Vec<ShardKeyDescription>>,`
`175`	`177`	`}`