Merge pull request #822 from OpenConceptLab/issue-2272-swagger-expansions

OpenConceptLab/ocl_issues#2272 | Add swagger docs for collection expansions endpoints

Author: paynejd

core/collections/views.py

@@ -52,7 +52,7 @@
 from core.common.serializers import TaskSerializer
 from core.common.swagger_parameters import q_param, compress_header, page_param, verbose_param, \
     include_facets_header, sort_asc_param, sort_desc_param, updated_since_param, include_retired_param, limit_param, \
-    canonical_url_param, all_versions_param
+    canonical_url_param, all_versions_param, include_summary_param
 from core.common.tasks import add_references, export_collection, delete_collection, index_expansion_concepts, \
     index_expansion_mappings, seed_children_to_expansion
 from core.common.throttling import ThrottleUtil
@@ -834,6 +834,9 @@ def get_object(self, queryset=None):
         self.check_object_permissions(self.request, instance)
         return instance
 
+    @swagger_auto_schema(
+        manual_parameters=[verbose_param, include_summary_param, page_param, limit_param]
+    )
     def get(self, request, *args, **kwargs):
         return self.list(request, *args, **kwargs)
 
@@ -853,6 +856,8 @@ def create(self, request, *args, **kwargs):
 
 
 class CollectionExpansionsView(CollectionBaseView, ListWithHeadersMixin):
+    """List all expansions across all versions of a collection."""
+
     def get_serializer_class(self):
         if self.is_verbose():
             return ExpansionDetailSerializer
@@ -863,6 +868,9 @@ def get_queryset(self):
         self.check_object_permissions(self.request, instance)
         return Expansion.objects.filter(collection_version_id__in=instance.versions.values_list('id', flat=True))
 
+    @swagger_auto_schema(
+        manual_parameters=[verbose_param, include_summary_param, page_param, limit_param]
+    )
     def get(self, request, *args, **kwargs):
         return self.list(request, *args, **kwargs)
 

core/common/swagger_parameters.py

@@ -6,7 +6,7 @@
     LAST_LOGIN_BEFORE_PARAM, LAST_LOGIN_SINCE_PARAM, DATE_JOINED_SINCE_PARAM, DATE_JOINED_BEFORE_PARAM, \
     CASCADE_HIERARCHY_PARAM, CASCADE_METHOD_PARAM, MAP_TYPES_PARAM, EXCLUDE_MAP_TYPES_PARAM, CASCADE_MAPPINGS_PARAM, \
     INCLUDE_MAPPINGS_PARAM, CASCADE_LEVELS_PARAM, CASCADE_DIRECTION_PARAM, ALL, RETURN_MAP_TYPES, OMIT_IF_EXISTS_IN, \
-    EQUIVALENCY_MAP_TYPES, CANONICAL_URL_REQUEST_PARAM
+    EQUIVALENCY_MAP_TYPES, CANONICAL_URL_REQUEST_PARAM, INCLUDE_SUMMARY
 # HEADERS
 from core.orgs.constants import NO_MEMBERS
 
@@ -187,6 +187,11 @@
     enum=['', 'hierarchy'],
     description='Hierarchy (nested) or Flat Response'
 )
+include_summary_param = openapi.Parameter(
+    INCLUDE_SUMMARY, openapi.IN_QUERY, type=openapi.TYPE_BOOLEAN, default=False,
+    description='Include summary counts of active concepts and mappings'
+)
+
 task_state_param = openapi.Parameter(
     'state',
     openapi.IN_QUERY,