Skip to content

Commit

Permalink
refactor: чуть-чуть документации
Browse files Browse the repository at this point in the history
  • Loading branch information
Denis-Shtanskiy committed Nov 3, 2024
1 parent 4606787 commit ff07ca0
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions src/backend/api/v1/projects/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,9 @@ class ProjectSpecialistsViewSet(
@extend_schema_view(
retrieve=extend_schema(exclude=True),
list=extend_schema(
description="Получение списка запросов на участие \
в проекте, для владельца. Или получение всех отправленных \
запросов на участие от пользователя-участника.",
parameters=[
OpenApiParameter(
"role",
Expand All @@ -301,11 +304,31 @@ class ProjectSpecialistsViewSet(
"participant",
], # Ограничение на допустимые значения
)
]
],
),
create=extend_schema(
description="Создание нового запроса на участие в проекте.",
),
update=extend_schema(
request=UpdateParticipationRequestSerializer,
description="Обновляет только сопроводительное письмо \
запроса на участие в проекте.",
),
destroy=extend_schema(
description="Удаление запроса участником на участие в проекте.",
),
)
class ProjectParticipationRequestsViewSet(ModelViewSet):
"""Представление для запросов на участие в проекте."""
"""
Представление для обработки запросов на участие в проекте.
Методы:
- list: Возвращает список всех запросов на участие.
- retrieve: Исключён.
- create: Создает новый запрос на участие.
- update: Обновляет существующий запрос, включая сопроводительное письмо.
- destroy: Удаляет запрос на участие.
"""

queryset = ParticipationRequest.objects.all()
permission_classes = (
Expand Down Expand Up @@ -379,7 +402,6 @@ def get_serializer_class(self) -> type[BaseSerializer]:
return MyRequestsSerializer
if self.request.method in [
"PATCH",
"PUT",
]:
return UpdateParticipationRequestSerializer
return WriteParticipationRequestSerializer
Expand Down

0 comments on commit ff07ca0

Please sign in to comment.