Update views.py- Added missing GET request parameters to swagger #734
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
snyaggarwal
reviewed
Sep 30, 2024
core/orgs/views.py
Outdated
| @swagger_auto_schema(manual_parameters=[org_no_members_param]) | ||
| @swagger_auto_schema( | ||
| manual_parameters=[ | ||
| openapi.Parameter('user', openapi.IN_PATH, description="Filter by username", type=openapi.TYPE_STRING), |
There was a problem hiding this comment.
user param in path cannot be added here. That comes from routes (urls.py), if you check users/urls.py its already added there. This will have no effect in the results and also its not mandatory.
core/orgs/views.py
Outdated
| manual_parameters=[ | ||
| openapi.Parameter('user', openapi.IN_PATH, description="Filter by username", type=openapi.TYPE_STRING), | ||
| openapi.Parameter(NO_MEMBERS, openapi.IN_QUERY, description="Filter organizations with no members", type=openapi.TYPE_BOOLEAN), | ||
| openapi.Parameter('updated_since', openapi.IN_QUERY, description="Filter by update date", type=openapi.TYPE_STRING, format=openapi.FORMAT_DATETIME), |
There was a problem hiding this comment.
updated_since -- updatedSince --> UPDATED_SINCE_PARAM
There was a problem hiding this comment.
Kindly provide more context
core/orgs/views.py
Outdated
| openapi.Parameter('user', openapi.IN_PATH, description="Filter by username", type=openapi.TYPE_STRING), | ||
| openapi.Parameter(NO_MEMBERS, openapi.IN_QUERY, description="Filter organizations with no members", type=openapi.TYPE_BOOLEAN), | ||
| openapi.Parameter('updated_since', openapi.IN_QUERY, description="Filter by update date", type=openapi.TYPE_STRING, format=openapi.FORMAT_DATETIME), | ||
| openapi.Parameter(UPDATED_BY_USERNAME_PARAM, openapi.IN_QUERY, description="Filter by username of user who updated", type=openapi.TYPE_STRING), |
There was a problem hiding this comment.
description=Filter Orgs by the update by user
core/orgs/views.py
Outdated
|
|
||
| @swagger_auto_schema( | ||
| manual_parameters=[ | ||
| openapi.Parameter('org', openapi.IN_PATH, description="Organization mnemonic", type=openapi.TYPE_STRING, required=True), |
There was a problem hiding this comment.
org is already part of this API /orgs/{org}/logo/ path. This will have no effect.
core/orgs/views.py
Outdated
| class OrganizationExtrasView(OrganizationExtrasBaseView): | ||
| serializer_class = OrganizationDetailSerializer | ||
|
|
||
| @swagger_auto_schema( | ||
| manual_parameters=[ | ||
| openapi.Parameter('org', openapi.IN_PATH, description="Organization mnemonic", type=openapi.TYPE_STRING, required=True), |
core/orgs/views.py
Outdated
| class OrganizationExtraRetrieveUpdateDestroyView(OrganizationExtrasBaseView, RetrieveUpdateDestroyAPIView): | ||
| serializer_class = OrganizationDetailSerializer | ||
|
|
||
| @swagger_auto_schema( | ||
| manual_parameters=[ | ||
| openapi.Parameter('org', openapi.IN_PATH, description="Organization mnemonic", type=openapi.TYPE_STRING, required=True), |
core/orgs/views.py
Outdated
| @swagger_auto_schema( | ||
| manual_parameters=[ | ||
| openapi.Parameter('org', openapi.IN_PATH, description="Organization mnemonic", type=openapi.TYPE_STRING, required=True), | ||
| openapi.Parameter('extra', openapi.IN_PATH, description="Extra field key", type=openapi.TYPE_STRING, required=True), |
core/orgs/views.py
Outdated
| @@ -286,6 +357,25 @@ def retrieve(self, request, *args, **kwargs): | |||
|
|
|||
| return Response({'detail': NOT_FOUND}, status=status.HTTP_404_NOT_FOUND) | |||
|
|
|||
| @swagger_auto_schema( | |||
| manual_parameters=[ | |||
| openapi.Parameter('org', openapi.IN_PATH, description="Organization mnemonic", type=openapi.TYPE_STRING, required=True), | |||
core/orgs/views.py
Outdated
| @@ -299,6 +389,16 @@ def update(self, request, **kwargs): # pylint: disable=arguments-differ | |||
| instance.set_checksums() | |||
| return Response({key: value}) | |||
|
|
|||
| @swagger_auto_schema( | |||
| manual_parameters=[ | |||
snyaggarwal
reviewed
Nov 5, 2024
core/orgs/views.py
Outdated
| @@ -286,6 +293,8 @@ def retrieve(self, request, *args, **kwargs): | |||
|
|
|||
| return Response({'detail': NOT_FOUND}, status=status.HTTP_404_NOT_FOUND) | |||
|
|
|||
|
|
|||
| ) | |||
There was a problem hiding this comment.
feels like a typo, not needed
core/orgs/views.py
Outdated
| @@ -299,6 +308,7 @@ def update(self, request, **kwargs): # pylint: disable=arguments-differ | |||
| instance.set_checksums() | |||
| return Response({key: value}) | |||
|
|
|||
|
|
|||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.