Skip to content

Commit 4424076

Browse files
paynejdclaude
andcommitted
OpenConceptLab/ocl_issues#2220 | Add allVersions param to swagger docs
The allVersions query parameter was implemented in commit 378f262 but swagger annotations were not added. This adds the parameter definition and includes it in the manual_parameters for source, collection, and repo list endpoints. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent ad1e369 commit 4424076

4 files changed

Lines changed: 12 additions & 6 deletions

File tree

core/collections/views.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
from core.common.serializers import TaskSerializer
5353
from core.common.swagger_parameters import q_param, compress_header, page_param, verbose_param, \
5454
include_facets_header, sort_asc_param, sort_desc_param, updated_since_param, include_retired_param, limit_param, \
55-
canonical_url_param
55+
canonical_url_param, all_versions_param
5656
from core.common.tasks import add_references, export_collection, delete_collection, index_expansion_concepts, \
5757
index_expansion_mappings
5858
from core.common.throttling import ThrottleUtil
@@ -187,7 +187,8 @@ def get_serializer_class(self):
187187
@swagger_auto_schema(
188188
manual_parameters=[
189189
q_param, limit_param, sort_desc_param, sort_asc_param, page_param, verbose_param,
190-
include_retired_param, updated_since_param, canonical_url_param, include_facets_header, compress_header
190+
include_retired_param, updated_since_param, canonical_url_param, all_versions_param,
191+
include_facets_header, compress_header
191192
]
192193
)
193194
def get(self, request, *args, **kwargs):

core/common/swagger_parameters.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,10 @@
6464
canonical_url_param = openapi.Parameter(
6565
CANONICAL_URL_REQUEST_PARAM, openapi.IN_QUERY, type=openapi.TYPE_STRING,
6666
)
67+
all_versions_param = openapi.Parameter(
68+
'allVersions', openapi.IN_QUERY, type=openapi.TYPE_BOOLEAN, default=False,
69+
description='Include all repo versions (default only shows HEAD versions)'
70+
)
6771

6872
released_param = openapi.Parameter(
6973
RELEASED_PARAM, openapi.IN_QUERY, type=openapi.TYPE_BOOLEAN, default=False,

core/repos/views.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
from core.common.mixins import ListWithHeadersMixin
55
from core.common.permissions import CanViewConceptDictionary
66
from core.common.swagger_parameters import q_param, limit_param, sort_desc_param, sort_asc_param, page_param, \
7-
include_retired_param, updated_since_param, compress_header, canonical_url_param
7+
include_retired_param, updated_since_param, compress_header, canonical_url_param, all_versions_param
88
from core.common.views import BaseAPIView
99
from core.repos.documents import RepoDocument
1010
from core.repos.search import RepoFacetedSearch
@@ -111,7 +111,7 @@ class ReposListView(BaseAPIView, ListWithHeadersMixin):
111111
@swagger_auto_schema(
112112
manual_parameters=[
113113
q_param, limit_param, sort_desc_param, sort_asc_param, page_param,
114-
include_retired_param, updated_since_param, canonical_url_param, compress_header
114+
include_retired_param, updated_since_param, canonical_url_param, all_versions_param, compress_header
115115
]
116116
)
117117
def get(self, request, *args, **kwargs):

core/sources/views.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
from core.common.serializers import TaskSerializer
2727
from core.common.swagger_parameters import q_param, limit_param, sort_desc_param, sort_asc_param, \
2828
page_param, verbose_param, include_retired_param, updated_since_param, include_facets_header, compress_header, \
29-
canonical_url_param
29+
canonical_url_param, all_versions_param
3030
from core.common.tasks import export_source, index_source_concepts, index_source_mappings, delete_source, \
3131
generate_source_resources_checksums, source_version_compare
3232
from core.common.utils import parse_boolean_query_param, compact_dict_by_values, to_parent_uri, decode_string
@@ -137,7 +137,8 @@ def get_serializer_class(self):
137137
@swagger_auto_schema(
138138
manual_parameters=[
139139
q_param, limit_param, sort_desc_param, sort_asc_param, page_param, verbose_param,
140-
include_retired_param, updated_since_param, canonical_url_param, include_facets_header, compress_header
140+
include_retired_param, updated_since_param, canonical_url_param, all_versions_param,
141+
include_facets_header, compress_header
141142
]
142143
)
143144
def get(self, request, *args, **kwargs):

0 commit comments

Comments
 (0)