default payload return is null + update openAPI

e-ivkov · Oct 24, 2021 · 29830f9 · 29830f9
1 parent 3a7485a
commit 29830f9
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 10 deletions.
diff --git a/docs/redoc/openapi.json b/docs/redoc/openapi.json
@@ -1354,6 +1354,7 @@
               "$ref": "#/components/schemas/PayloadType"
             },
             "description": "Payload storage",
+            "nullable": true,
             "type": "object"
           },
           "score": {
@@ -1370,7 +1371,6 @@
         },
         "required": [
           "id",
-          "payload",
           "score",
           "version"
         ],

diff --git a/lib/collection/tests/collection_test.rs b/lib/collection/tests/collection_test.rs
@@ -69,7 +69,7 @@ async fn test_collection_updater() {
         Ok(res) => {
             assert_eq!(res.len(), 3);
             assert_eq!(res[0].id, 2);
-            assert_eq!(res[0].payload.len(), 0);
+            assert!(res[0].payload.is_none());
         }
         Err(err) => panic!("search failed: {:?}", err),
     }
@@ -121,7 +121,11 @@ async fn test_collection_search_with_payload() {
         Ok(res) => {
             assert_eq!(res.len(), 2);
             assert_eq!(res[0].id, 0);
-            assert_eq!(res[0].payload.len(), 1);
+            if let Some(payload) = &res[0].payload {
+                assert_eq!(payload.len(), 1)
+            } else {
+                panic!("Payload was expected")
+            }
         }
         Err(err) => panic!("search failed: {:?}", err),
     }

diff --git a/lib/segment/src/segment.rs b/lib/segment/src/segment.rs
@@ -238,13 +238,14 @@ impl SegmentEntry for Segment {
                         })?;
                 let payload = if with_payload.enable {
                     let initial_payload = self.payload(point_id)?;
-                    if let Some(i) = &with_payload.payload_selector {
+                    let processed_payload = if let Some(i) = &with_payload.payload_selector {
                         i.process(initial_payload)
                     } else {
                         initial_payload
-                    }
+                    };
+                    Some(processed_payload)
                 } else {
-                    TheMap::new()
+                    None
                 };
                 Ok(ScoredPoint {
                     id: point_id,

diff --git a/lib/segment/src/types.rs b/lib/segment/src/types.rs
@@ -48,7 +48,7 @@ pub struct ScoredPoint {
     /// Points vector distance to the query vector
     pub score: ScoreType,
     /// Payload storage
-    pub payload: TheMap<PayloadKeyType, PayloadType>,
+    pub payload: Option<TheMap<PayloadKeyType, PayloadType>>,
 }
 
 impl Eq for ScoredPoint {}

diff --git a/openapi/models.json b/openapi/models.json
@@ -1322,7 +1322,6 @@
                 "type": "object",
                 "required": [
                     "id",
-                    "payload",
                     "score",
                     "version"
                 ],
@@ -1338,7 +1337,8 @@
                         "type": "object",
                         "additionalProperties": {
                             "$ref": "#/components/schemas/PayloadType"
-                        }
+                        },
+                        "nullable": true
                     },
                     "score": {
                         "description": "Points vector distance to the query vector",

diff --git a/openapi/openapi-merged.yaml b/openapi/openapi-merged.yaml
@@ -1527,6 +1527,7 @@ components:
           additionalProperties:
             $ref: '#/components/schemas/PayloadType'
           description: Payload storage
+          nullable: true
           type: object
         score:
           description: Points vector distance to the query vector
@@ -1539,7 +1540,6 @@ components:
           type: integer
       required:
       - id
-      - payload
       - score
       - version
       type: object