rename class CurationSuggestResultItem to LabelValueItem

project/dalia/api_models/api_models.py

@@ -11,10 +11,10 @@ from typing import List, Literal, Optional, Union
 
 @dataclass
 class PaginatedResult:
+    # TODO: add validation, e.g. min_value
     count: Optional[int] = None
     offset: Optional[int] = None
     limit: Optional[int] = None
-    # results: Optional[List] = None
 
 
 # added manually
@@ -225,18 +225,18 @@ class CurationSuggestSearchRequest:
 
 
 @dataclass
-class CurationSuggestResultItem:
+class LabelValueItem:
     label: str
     value: str
 
 
 @dataclass
 class CurationSuggestPaginatedResult(PaginatedResult):
-    results: List[CurationSuggestResultItem] = None
+    results: List[LabelValueItem] = None
 
 
 @dataclass
-class CurationSuggestDisciplinesResultItem(CurationSuggestResultItem):
+class CurationSuggestDisciplinesResultItem(LabelValueItem):
     children: List[CurationSuggestDisciplinesResultItem]
 
 

project/dalia/curation/suggest/communities.py

@@ -5,8 +5,8 @@ from rdflib.collection import Collection
 
 from project.dalia.api_models.api_models import (
     CurationSuggestPaginatedResult,
-    CurationSuggestResultItem,
     CurationSuggestSearchRequest,
+    LabelValueItem,
 )
 from project.dalia.query.utils import query_dalia_dataset
 from project.dalia.query_builder.query_builder import Aggregates, FunctionExpressions, QueryBuilder
@@ -75,15 +75,15 @@ def prepare_query_for_count_in_community_search(query: str) -> str:
     ).build()
 
 
-def _search_communities_and_retrieve_titles(query: str, limit: int, offset: int) -> List[CurationSuggestResultItem]:
+def _search_communities_and_retrieve_titles(query: str, limit: int, offset: int) -> List[LabelValueItem]:
     sparql_query = prepare_query_for_community_search_and_title_retrieval(query, limit, offset)
     results = query_dalia_dataset(sparql_query)
 
     return [_process_result_from_metadata_retrieval(result) for result in results]
 
 
-def _process_result_from_metadata_retrieval(result) -> CurationSuggestResultItem:
-    return CurationSuggestResultItem(
+def _process_result_from_metadata_retrieval(result) -> LabelValueItem:
+    return LabelValueItem(
         value=str(result.community),
         label=str(result.title)
     )

tests/project/dalia/curation/suggest/test_communities.py

@@ -5,8 +5,8 @@ from rest_framework.exceptions import ErrorDetail
 
 from project.dalia.api_models.api_models import (
     CurationSuggestPaginatedResult,
-    CurationSuggestResultItem,
     CurationSuggestSearchRequest,
+    LabelValueItem,
 )
 from project.dalia.curation.suggest.communities import (
     count_results_from_community_search, get_communities_suggestions,
@@ -106,11 +106,11 @@ def test_count_results_from_community_search(
                     offset=0,
                     limit=2,
                     results=[
-                        CurationSuggestResultItem(
+                        LabelValueItem(
                             label='DAPHNE4NFDI',
                             value='https://id.dalia.education/community/0393d642-340d-4641-8c1f-e9c8b27199bf'
                         ),
-                        CurationSuggestResultItem(
+                        LabelValueItem(
                             label='RADAR',
                             value='https://id.dalia.education/community/0957e041-54d9-4f72-812c-013fcc48c2f3'
                         ),
@@ -124,7 +124,7 @@ def test_count_results_from_community_search(
                     offset=10,
                     limit=1,
                     results=[
-                        CurationSuggestResultItem(
+                        LabelValueItem(
                             label='NFDI4Cat',
                             value='https://id.dalia.education/community/7783f91b-2496-4c1b-97ef-9db578d237ca'
                         ),