Merge pull request #52 from bugout-dev/search-entity

Search entity representation

Author: kompotkot

bugout/__init__.py

@@ -7,7 +7,7 @@
 
 __email__ = "[email protected]"
 __license__ = "MIT"
-__version__ = "0.2.11"
+__version__ = "0.2.12"
 
 __all__ = (
     "__author__",

bugout/app.py

@@ -1035,6 +1035,9 @@ def search(
         content: bool = True,
         timeout: float = REQUESTS_TIMEOUT,
         order: SearchOrder = SearchOrder.DESCENDING,
+        representation: Union[
+            str, data.EntryRepresentationTypes
+        ] = data.EntryRepresentationTypes.ENTRY,
         auth_type: str = data.AuthType.bearer.name,
         **kwargs: Dict[str, Any],
     ) -> data.BugoutSearchResults:
@@ -1048,6 +1051,7 @@ def search(
             offset,
             content,
             order=order,
+            representation=data.EntryRepresentationTypes(representation),
             auth_type=data.AuthType[auth_type],
             **kwargs,
         )

bugout/data.py

@@ -272,14 +272,6 @@ class BugoutSearchResult(BaseModel):
     context_id: Optional[str] = None
 
 
-class BugoutSearchResults(BaseModel):
-    total_results: int
-    offset: int
-    next_offset: Optional[int]
-    max_score: float
-    results: List[BugoutSearchResult]
-
-
 class BugoutHumbugIntegration(BaseModel):
     id: uuid.UUID
     group_id: uuid.UUID
@@ -338,3 +330,26 @@ class BugoutJournalEntity(BaseModel):
 
 class BugoutJournalEntities(BaseModel):
     entities: List[BugoutJournalEntity] = Field(default_factory=list)
+
+
+class BugoutSearchResultAsEntity(BaseModel):
+    journal_id: str
+    entity_url: str
+    title: str
+    address: Optional[str] = None
+    blockchain: Optional[str] = None
+    required_fields: List[Dict[str, Any]] = Field(default_factory=list)
+    secondary_fields: Dict[str, Any] = Field(default_factory=dict)
+    created_at: str
+    updated_at: str
+    score: float
+
+
+class BugoutSearchResults(BaseModel):
+    total_results: int
+    offset: int
+    next_offset: Optional[int]
+    max_score: float
+    results: List[Union[BugoutSearchResult, BugoutSearchResultAsEntity]] = Field(
+        default_factory=list
+    )

bugout/journal.py

@@ -21,6 +21,7 @@
     BugoutJournalScopeSpecs,
     BugoutScopes,
     BugoutSearchResults,
+    EntryRepresentationTypes,
     HolderType,
     JournalTypes,
     Method,
@@ -729,6 +730,7 @@ def search(
         offset: int = 0,
         content: bool = True,
         order: SearchOrder = SearchOrder.DESCENDING,
+        representation: EntryRepresentationTypes = EntryRepresentationTypes.ENTRY,
         auth_type: AuthType = AuthType.bearer,
         **kwargs: Dict[str, Any],
     ) -> BugoutSearchResults:
@@ -745,6 +747,7 @@ def search(
             "offset": offset,
             "content": content,
             "order": order.value,
+            "representation": representation.value,
         }
         result = self._call(
             method=Method.get, path=search_path, params=query_params, headers=headers