Merge pull request #821 from OpenConceptLab/issue-2220-swagger-allversions

OpenConceptLab/ocl_issues#2220 | Add allVersions param to swagger docs

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
+    canonical_url_param, all_versions_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
@@ -187,7 +187,8 @@ def get_serializer_class(self):
     @swagger_auto_schema(
         manual_parameters=[
             q_param, limit_param, sort_desc_param, sort_asc_param, page_param, verbose_param,
-            include_retired_param, updated_since_param, canonical_url_param, include_facets_header, compress_header
+            include_retired_param, updated_since_param, canonical_url_param, all_versions_param,
+            include_facets_header, compress_header
         ]
     )
     def get(self, request, *args, **kwargs):

core/common/swagger_parameters.py

@@ -64,6 +64,10 @@
 canonical_url_param = openapi.Parameter(
     CANONICAL_URL_REQUEST_PARAM, openapi.IN_QUERY, type=openapi.TYPE_STRING,
 )
+all_versions_param = openapi.Parameter(
+    'allVersions', openapi.IN_QUERY, type=openapi.TYPE_BOOLEAN, default=False,
+    description='Include all repo versions (default only shows HEAD versions)'
+)
 
 released_param = openapi.Parameter(
     RELEASED_PARAM, openapi.IN_QUERY, type=openapi.TYPE_BOOLEAN, default=False,

core/repos/views.py

@@ -4,7 +4,7 @@
 from core.common.mixins import ListWithHeadersMixin
 from core.common.permissions import CanViewConceptDictionary
 from core.common.swagger_parameters import q_param, limit_param, sort_desc_param, sort_asc_param, page_param, \
-    include_retired_param, updated_since_param, compress_header, canonical_url_param
+    include_retired_param, updated_since_param, compress_header, canonical_url_param, all_versions_param
 from core.common.views import BaseAPIView
 from core.repos.documents import RepoDocument
 from core.repos.search import RepoFacetedSearch
@@ -122,7 +122,7 @@ class ReposListView(BaseAPIView, ListWithHeadersMixin):
     @swagger_auto_schema(
         manual_parameters=[
             q_param, limit_param, sort_desc_param, sort_asc_param, page_param,
-            include_retired_param, updated_since_param, canonical_url_param, compress_header
+            include_retired_param, updated_since_param, canonical_url_param, all_versions_param, compress_header
         ]
     )
     def get(self, request, *args, **kwargs):

core/sources/views.py

@@ -25,7 +25,7 @@
 from core.common.serializers import TaskSerializer
 from core.common.swagger_parameters import q_param, limit_param, sort_desc_param, sort_asc_param, \
     page_param, verbose_param, include_retired_param, updated_since_param, include_facets_header, compress_header, \
-    canonical_url_param
+    canonical_url_param, all_versions_param
 from core.common.tasks import export_source, index_source_concepts, index_source_mappings, delete_source, \
     generate_source_resources_checksums, source_version_compare
 from core.common.utils import parse_boolean_query_param, compact_dict_by_values, to_parent_uri, decode_string, \
@@ -127,7 +127,8 @@ def get_serializer_class(self):
     @swagger_auto_schema(
         manual_parameters=[
             q_param, limit_param, sort_desc_param, sort_asc_param, page_param, verbose_param,
-            include_retired_param, updated_since_param, canonical_url_param, include_facets_header, compress_header
+            include_retired_param, updated_since_param, canonical_url_param, all_versions_param,
+            include_facets_header, compress_header
         ]
     )
     def get(self, request, *args, **kwargs):