Concept brief response '?brief=true' | returns uuid and id only

core/common/constants.py

@@ -16,6 +16,7 @@
 SUPER_ADMIN_USER_ID = 1
 OCL_ORG_ID = 1
 VERBOSE_PARAM = 'verbose'
+BRIEF_PARAM = 'brief'
 UPDATED_SINCE_PARAM = 'updatedSince'
 LAST_LOGIN_SINCE_PARAM = 'lastLoginSince'
 LAST_LOGIN_BEFORE_PARAM = 'lastLoginBefore'

core/common/views.py

@@ -20,7 +20,8 @@
 
 from core import __version__
 from core.common.constants import SEARCH_PARAM, LIST_DEFAULT_LIMIT, CSV_DEFAULT_LIMIT, \
-    LIMIT_PARAM, NOT_FOUND, MUST_SPECIFY_EXTRA_PARAM_IN_BODY, INCLUDE_RETIRED_PARAM, VERBOSE_PARAM, HEAD, LATEST
+    LIMIT_PARAM, NOT_FOUND, MUST_SPECIFY_EXTRA_PARAM_IN_BODY, INCLUDE_RETIRED_PARAM, VERBOSE_PARAM, HEAD, LATEST, \
+    BRIEF_PARAM
 from core.common.mixins import PathWalkerMixin
 from core.common.serializers import RootSerializer
 from core.common.utils import compact_dict_by_values, to_snake_case, to_camel_case, parse_updated_since_param, \
@@ -65,6 +66,9 @@ def _should_include_private(self):
     def is_verbose(self):
         return self.request.query_params.get(VERBOSE_PARAM, False) in ['true', True]
 
+    def is_brief(self):
+        return self.request.query_params.get(BRIEF_PARAM, False) in ['true', True]
+
     def initial(self, request, *args, **kwargs):
         super().initial(request, *args, **kwargs)
         self.initialize(request, request.path_info, **kwargs)

core/concepts/serializers.py

@@ -209,6 +209,15 @@ def get_versions(obj):
         return obj.versions.count()
 
 
+class ConceptMinimalSerializer(ModelSerializer):
+    uuid = CharField(source='id', read_only=True)
+    id = CharField(source='mnemonic', read_only=True)
+
+    class Meta:
+        model = Concept
+        fields = ('uuid', 'id')
+
+
 class ConceptDetailSerializer(ModelSerializer):
     uuid = CharField(source='id', read_only=True)
     version = CharField(read_only=True)

core/concepts/views.py

@@ -30,7 +30,7 @@
 from core.concepts.serializers import (
     ConceptDetailSerializer, ConceptListSerializer, ConceptDescriptionSerializer, ConceptNameSerializer,
     ConceptVersionDetailSerializer,
-    ConceptVersionListSerializer, ConceptHierarchySerializer, ConceptSummarySerializer)
+    ConceptVersionListSerializer, ConceptHierarchySerializer, ConceptSummarySerializer, ConceptMinimalSerializer)
 from core.mappings.serializers import MappingListSerializer
 
 
@@ -54,14 +54,19 @@ class ConceptVersionListAllView(ConceptBaseView, ListWithHeadersMixin):
     permission_classes = (CanViewParentDictionary,)
 
     def get_serializer_class(self):
-        return ConceptDetailSerializer if self.is_verbose() else ConceptListSerializer
+        if self.is_verbose():
+            return ConceptDetailSerializer
+        if self.is_brief():
+            return ConceptMinimalSerializer
+        return ConceptListSerializer
 
     def get_queryset(self):
-        return Concept.global_listing_queryset(
-            self.get_filter_params(), self.request.user
-        ).select_related(
-            'parent__organization', 'parent__user',
-        ).prefetch_related('names', 'descriptions')
+        queryset = Concept.global_listing_queryset(self.get_filter_params(), self.request.user)
+        if self.is_brief():
+            return queryset
+
+        return queryset.select_related(
+            'parent__organization', 'parent__user',).prefetch_related('names', 'descriptions')
 
     @swagger_auto_schema(
         manual_parameters=[
@@ -84,7 +89,12 @@ def get_permissions(self):
         return [CanViewParentDictionary(), ]
 
     def get_serializer_class(self):
-        if (self.request.method == 'GET' and self.is_verbose()) or self.request.method == 'POST':
+        method = self.request.method
+        is_get = method == 'GET'
+
+        if is_get and self.is_brief():
+            return ConceptMinimalSerializer
+        if (is_get and self.is_verbose()) or method == 'POST':
             return ConceptDetailSerializer
 
         return ConceptListSerializer
@@ -96,9 +106,10 @@ def get_queryset(self):
         if is_latest_version:
             queryset = queryset.filter(is_latest_version=True)
 
-        return queryset.select_related(
-            'parent__organization', 'parent__user', 'created_by'
-        ).prefetch_related('names')
+        if self.is_brief():
+            return queryset
+
+        return queryset.select_related('parent__organization', 'parent__user', 'created_by').prefetch_related('names')
 
     def get(self, request, *args, **kwargs):
         self.set_parent_resource(False)