Add models docs after pulling

This commit is contained in:
Степаненко Ольга 2021-03-23 20:22:42 +03:00
parent b483998686
commit 2ce272d206

View File

@ -7,8 +7,9 @@ from django.utils import timezone
class UserProfile(models.Model): class UserProfile(models.Model):
""" """
Модель профиля пользователя Модель профиля пользователя.
Профиль создается и изменяется при создании и изменении модель User.
""" """
class Meta: class Meta:
@ -36,8 +37,7 @@ def save_user_profile(sender, instance, **kwargs):
class RoleChangeLogs(models.Model): class RoleChangeLogs(models.Model):
""" """
Модель для логирования изменений ролей пользователя Модель для логирования изменений ролей пользователя.
""" """
user = models.ForeignKey(to=User, on_delete=models.CASCADE, user = models.ForeignKey(to=User, on_delete=models.CASCADE,
@ -50,6 +50,15 @@ class RoleChangeLogs(models.Model):
class UnassignedTicketStatus(models.IntegerChoices): class UnassignedTicketStatus(models.IntegerChoices):
"""
Класс статусов нераспределенных тикетов.
:param UNASSIGNED: Снят с пользователя, перенесён в буферную группу
:param RESTORED: Авторство восстановлено
:param NOT_FOUND: Пока нас не было, тикет испарился из буферной группы. Дополнительные действия не требуются
:param CLOSED: Тикет уже был закрыт. Дополнительные действия не требуются
:param SOLVED: Тикет решён. Записан на пользователя с почтой SOLVED_TICKETS_EMAIL
"""
UNASSIGNED = 0, 'Снят с пользователя, перенесён в буферную группу' UNASSIGNED = 0, 'Снят с пользователя, перенесён в буферную группу'
RESTORED = 1, 'Авторство восстановлено' RESTORED = 1, 'Авторство восстановлено'
NOT_FOUND = 2, 'Пока нас не было, тикет испарился из буферной группы. Дополнительные действия не требуются' NOT_FOUND = 2, 'Пока нас не было, тикет испарился из буферной группы. Дополнительные действия не требуются'
@ -58,6 +67,9 @@ class UnassignedTicketStatus(models.IntegerChoices):
class UnassignedTicket(models.Model): class UnassignedTicket(models.Model):
assignee = models.ForeignKey(to=User, on_delete=models.CASCADE, related_name='tickets') """
Модель нераспределенного тикета.
"""
assignee = models.ForeignKey(to=User, on_delete=models.CASCADE, related_name='tickets', help_text='Пользователь, с которого снят тикет')
ticket_id = models.IntegerField(help_text='Номер тикера, для которого сняли ответственного') ticket_id = models.IntegerField(help_text='Номер тикера, для которого сняли ответственного')
status = models.IntegerField(choices=UnassignedTicketStatus.choices, default=UnassignedTicketStatus.UNASSIGNED) status = models.IntegerField(choices=UnassignedTicketStatus.choices, default=UnassignedTicketStatus.UNASSIGNED, help_text='Статус тикета')