Improve description of vector parameters in update collection REST call

qdrant · Oct 5, 2023 · 2bc830c · 2bc830c
1 parent b916617
commit 2bc830c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/docs/redoc/master/openapi.json b/docs/redoc/master/openapi.json
@@ -6775,7 +6775,7 @@
         "type": "object",
         "properties": {
           "vectors": {
-            "description": "Vector data parameters to update. It is possible to provide one config for single vector mode and list of configs for multiple vectors mode.",
+            "description": "Vector data parameters to update per named vector. To update parameters in a collection having a single unnamed vector, use an empty string as name.",
             "anyOf": [
               {
                 "$ref": "#/components/schemas/VectorsConfigDiff"

diff --git a/lib/storage/src/content_manager/collection_meta_ops.rs b/lib/storage/src/content_manager/collection_meta_ops.rs
@@ -180,8 +180,8 @@ impl CreateCollectionOperation {
 #[derive(Debug, Deserialize, Serialize, JsonSchema, Validate, PartialEq, Eq, Hash, Clone)]
 #[serde(rename_all = "snake_case")]
 pub struct UpdateCollection {
-    /// Vector data parameters to update.
-    /// It is possible to provide one config for single vector mode and list of configs for multiple vectors mode.
+    /// Map of vector data parameters to update for each named vector.
+    /// To update parameters in a collection having a single unnamed vector, use an empty string as name.
     #[validate]
     pub vectors: Option<VectorsConfigDiff>,
     /// Custom params for Optimizers.  If none - it is left unchanged.