feat: add project, data connector counts in Search result (#1198)

Author: andre-code

components/renku_data_services/search/api.spec.yaml

@@ -119,6 +119,10 @@ components:
             description: The search query.
             type: string
             default: ""
+          include_counts:
+            description: Include counts (project_count, data_connector_count) in the results.
+            type: boolean
+            default: false
     PaginationRequest:
       type: object
       additionalProperties: false
@@ -226,7 +230,7 @@ components:
           type: integer
           format: int32
     SearchProject:
-      title: Project
+      title: SearchProject
       examples:
         - type: Project
           id: 01HRA7AZ2Q234CDQWGA052F8MK
@@ -302,7 +306,7 @@ components:
           type: string
           const: Project
     SearchDataConnector:
-      title: DataConnector
+      title: SearchDataConnector
       examples:
         - type: DataConnector
           id: 01HRA7AZ2Q234CDQWGA052F8MK
@@ -379,16 +383,16 @@ components:
     SearchEntity:
       title: SearchEntity
       oneOf:
-        - $ref: '#/components/schemas/Group'
+        - $ref: '#/components/schemas/SearchGroup'
         - $ref: '#/components/schemas/SearchProject'
-        - $ref: '#/components/schemas/User'
+        - $ref: '#/components/schemas/SearchUser'
         - $ref: '#/components/schemas/SearchDataConnector'
       discriminator:
         propertyName: type
         mapping:
-          Group: '#/components/schemas/Group'
+          Group: '#/components/schemas/SearchGroup'
           Project: '#/components/schemas/SearchProject'
-          User: '#/components/schemas/User'
+          User: '#/components/schemas/SearchUser'
           DataConnector: '#/components/schemas/SearchDataConnector'
     SearchResult:
       title: SearchResult
@@ -438,6 +442,73 @@ components:
         type:
           type: string
           const: User
+    SearchUser:
+      title: SearchUser
+      type: object
+      required:
+        - id
+        - type
+        - path
+        - slug
+      properties:
+        id:
+          type: string
+        path:
+          type: string
+        slug:
+          type: string
+        firstName:
+          type: string
+        lastName:
+          type: string
+        score:
+          type: number
+          format: double
+        project_count:
+          description: Number of projects with this user namespace.
+          type: integer
+          format: int32
+        data_connector_count:
+          description: Number of data connectors with this user namespace.
+          type: integer
+          format: int32
+        type:
+          type: string
+          const: User
+    SearchGroup:
+      title: SearchGroup
+      type: object
+      required:
+        - id
+        - name
+        - path
+        - slug
+        - type
+      properties:
+        id:
+          type: string
+        path:
+          type: string
+        slug:
+          type: string
+        name:
+          type: string
+        description:
+          type: string
+        score:
+          type: number
+          format: double
+        type:
+          type: string
+          const: Group
+        project_count:
+          description: Number of projects with this group namespace.
+          type: integer
+          format: int32
+        data_connector_count:
+          description: Number of data connectors with this group namespace.
+          type: integer
+          format: int32
     UserOrGroup:
       title: UserOrGroup
       examples:

components/renku_data_services/search/apispec.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  api.spec.yaml
-#   timestamp: 2025-06-12T09:56:04+00:00
+#   timestamp: 2026-02-03T22:16:13+00:00
 
 from __future__ import annotations
 
@@ -59,6 +59,38 @@ class User(BaseAPISpec):
     type: Literal["User"] = "User"
 
 
+class SearchUser(BaseAPISpec):
+    id: str
+    path: str
+    slug: str
+    firstName: Optional[str] = None
+    lastName: Optional[str] = None
+    score: Optional[float] = None
+    project_count: Optional[int] = Field(
+        None, description="Number of projects with this user namespace."
+    )
+    data_connector_count: Optional[int] = Field(
+        None, description="Number of data connectors with this user namespace."
+    )
+    type: Literal["User"] = "User"
+
+
+class SearchGroup(BaseAPISpec):
+    id: str
+    path: str
+    slug: str
+    name: str
+    description: Optional[str] = None
+    score: Optional[float] = None
+    type: Literal["Group"] = "Group"
+    project_count: Optional[int] = Field(
+        None, description="Number of projects with this group namespace."
+    )
+    data_connector_count: Optional[int] = Field(
+        None, description="Number of data connectors with this group namespace."
+    )
+
+
 class UserOrGroup(RootModel[Union[Group, User]]):
     root: Union[Group, User] = Field(
         ...,
@@ -108,6 +140,10 @@ class ErrorResponse(BaseAPISpec):
 
 class SearchQuery(PaginationRequest):
     q: str = Field("", description="The search query.")
+    include_counts: bool = Field(
+        False,
+        description="Include counts (project_count, data_connector_count) in the results.",
+    )
 
 
 class FacetData(BaseAPISpec):
@@ -183,8 +219,10 @@ class SearchDataConnector(BaseAPISpec):
     type: Literal["DataConnector"] = "DataConnector"
 
 
-class SearchEntity(RootModel[Union[Group, SearchProject, User, SearchDataConnector]]):
-    root: Union[Group, SearchProject, User, SearchDataConnector] = Field(
+class SearchEntity(
+    RootModel[Union[SearchGroup, SearchProject, SearchUser, SearchDataConnector]]
+):
+    root: Union[SearchGroup, SearchProject, SearchUser, SearchDataConnector] = Field(
         ..., discriminator="type", title="SearchEntity"
     )
 

components/renku_data_services/search/blueprints.py

@@ -85,7 +85,14 @@ async def _query(_: Request, user: base_models.APIUser, query: SearchQuery) -> H
             logger.debug(f"Running search query: {query}")
 
             result = await core.query(
-                self.authz.client, self.username_resolve, self.solr_config, uq, user, per_page, offset
+                self.authz.client,
+                self.username_resolve,
+                self.solr_config,
+                uq,
+                user,
+                per_page,
+                offset,
+                include_counts=query.include_counts,
             )
             await self.metrics.search_queried(user)
             return json(

components/renku_data_services/search/converters.py

@@ -1,7 +1,5 @@
 """Conversion functions."""
 
-from typing import cast
-
 from renku_data_services.authz.models import Visibility
 from renku_data_services.search.apispec import (
     Group as GroupApi,
@@ -14,9 +12,15 @@
     UserOrGroup,
     UserOrGroupOrProject,
 )
+from renku_data_services.search.apispec import (
+    SearchGroup as SearchGroupApi,
+)
 from renku_data_services.search.apispec import (
     SearchProject as ProjectApi,
 )
+from renku_data_services.search.apispec import (
+    SearchUser as SearchUserApi,
+)
 from renku_data_services.search.apispec import (
     User as UserApi,
 )
@@ -49,50 +53,88 @@ def from_visibility(v: Visibility) -> VisibilityApi:
             return VisibilityApi.private
 
 
-def from_user(user: UserDocument) -> UserApi:
+def from_user(user: UserDocument) -> SearchUserApi:
     """Creates an apispec user from a solr user document."""
-    return UserApi(
+    return SearchUserApi(
         id=user.id,
         slug=user.slug.value,
         path=user.path,
         firstName=user.firstName,
         lastName=user.lastName,
         score=user.score,
+        project_count=None,
+        data_connector_count=None,
     )
 
 
-def from_group(group: GroupDocument) -> GroupApi:
+def from_group(group: GroupDocument) -> SearchGroupApi:
     """Creates a apispec group from a solr group document."""
-    return GroupApi(
+    return SearchGroupApi(
         id=str(group.id),
         name=group.name,
         slug=group.slug.value,
         path=group.path,
         description=group.description,
         score=group.score,
+        project_count=None,
+        data_connector_count=None,
     )
 
 
 def __creator_details(e: ProjectDocument | DataConnectorDocument) -> UserApi | None:
     if e.creatorDetails is not None and e.creatorDetails.docs != []:
-        return from_user(UserDocument.from_dict(e.creatorDetails.docs[0]))
+        return __user_to_base(UserDocument.from_dict(e.creatorDetails.docs[0]))
     else:
         return None
 
 
+def __user_to_base(user: UserDocument) -> UserApi:
+    """Creates a base User (not SearchUser) from a solr user document."""
+    return UserApi(
+        id=user.id,
+        slug=user.slug.value,
+        path=user.path,
+        firstName=user.firstName,
+        lastName=user.lastName,
+        score=user.score,
+    )
+
+
+def __group_to_base(group: GroupDocument) -> GroupApi:
+    """Creates a base Group (not SearchGroup) from a solr group document."""
+    return GroupApi(
+        id=str(group.id),
+        name=group.name,
+        slug=group.slug.value,
+        path=group.path,
+        description=group.description,
+        score=group.score,
+    )
+
+
 def __namespace_details(d: ProjectDocument) -> UserOrGroup | None:
     if d.namespaceDetails is not None and d.namespaceDetails.docs != []:
         e = EntityDocReader.from_dict(d.namespaceDetails.docs[0])
         if e is not None:
-            return UserOrGroup(cast(UserApi | GroupApi, from_entity(e).root))
+            match e:
+                case UserDocument() as user_doc:
+                    return UserOrGroup(__user_to_base(user_doc))
+                case GroupDocument() as group_doc:
+                    return UserOrGroup(__group_to_base(group_doc))
     return None
 
 
 def __namespace_details_dc(d: DataConnectorDocument) -> UserOrGroupOrProject | None:
     if d.namespaceDetails is not None and d.namespaceDetails.docs != []:
         e = EntityDocReader.from_dict(d.namespaceDetails.docs[0])
         if e is not None:
-            return UserOrGroupOrProject(cast(UserApi | GroupApi | ProjectApi, from_entity(e).root))
+            match e:
+                case UserDocument() as user_doc:
+                    return UserOrGroupOrProject(__user_to_base(user_doc))
+                case GroupDocument() as group_doc:
+                    return UserOrGroupOrProject(__group_to_base(group_doc))
+                case ProjectDocument() as project_doc:
+                    return UserOrGroupOrProject(from_project(project_doc))
     return None