Skip to content

Commit 453a6c9

Browse files
committed
fix: refactor get_response_body_api method to improve clarity and consistency
1 parent 35bbe49 commit 453a6c9

File tree

2 files changed

+3
-20
lines changed

2 files changed

+3
-20
lines changed

apps/setting/serializers/team_serializers.py

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -171,24 +171,6 @@ def get_request_body_api():
171171
}
172172
)
173173

174-
@staticmethod
175-
def get_response_body_api():
176-
return openapi.Schema(
177-
type=openapi.TYPE_OBJECT,
178-
properties={
179-
'id': openapi.Schema(type=openapi.TYPE_STRING, title=_('user id'), description=_('user id')),
180-
'username': openapi.Schema(type=openapi.TYPE_STRING, title=_('Username'), description=_('Username')),
181-
'email': openapi.Schema(type=openapi.TYPE_STRING, title=_('Email'), description=_('Email')),
182-
'role': openapi.Schema(type=openapi.TYPE_STRING, title=_('Role'), description=_('Role')),
183-
'is_active': openapi.Schema(type=openapi.TYPE_STRING, title=_('Is active'),
184-
description=_('Is active')),
185-
'team_id': openapi.Schema(type=openapi.TYPE_STRING, title=_('team id'), description=_('team id')),
186-
'user_id': openapi.Schema(type=openapi.TYPE_STRING, title=_('user id'), description=_('user id')),
187-
'type': openapi.Schema(type=openapi.TYPE_STRING, title=_('member type'),
188-
description=_('member type manage|member')),
189-
}
190-
)
191-
192174
@transaction.atomic
193175
def batch_add_member(self, user_id_list: List[str], with_valid=True):
194176
"""
@@ -261,7 +243,8 @@ def list_member(self, with_valid=True):
261243
'team_id': self.data.get("team_id"), 'user_id': manage_member.id, 'type': 'manage'
262244
}, *member_list]
263245

264-
def get_response_body_api(self):
246+
@staticmethod
247+
def get_response_body_api():
265248
return get_api_response(openapi.Schema(
266249
type=openapi.TYPE_ARRAY, title=_('member list'), description=_('member list'),
267250
items=UserSerializer().get_response_body_api()

apps/setting/views/Team.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class Batch(APIView):
5454
@swagger_auto_schema(operation_summary=_('Add members in batches'),
5555
operation_id=_('Add members in batches'),
5656
request_body=TeamMemberSerializer.get_bach_request_body_api(),
57-
responses=result.get_api_array_response(TeamMemberSerializer.get_response_body_api()),
57+
responses=TeamMemberSerializer.get_response_body_api(),
5858
tags=[_('Team')])
5959
@has_permissions(PermissionConstants.TEAM_CREATE)
6060
@log(menu='Team', operate='Add members in batches',

0 commit comments

Comments
 (0)