Browse Source

help_text++

blezz-tech 1 month ago
parent
commit
8644086948
3 changed files with 58 additions and 43 deletions
  1. 1 3
      docs/database/client.py
  2. 18 5
      docs/database/permissions.py
  3. 39 35
      docs/database/provider.py

+ 1 - 3
docs/database/client.py

@@ -24,6 +24,4 @@ class Client():
         "меняет статус на закрытый - вызывается проверка, которая смотрит, "
         "нет ли другого открытого по пользователю."
     )
-    user = (
-        "пользователь, которому соответствует роль клиента"
-    )
+    user = "пользователь, которому соответствует роль клиента"

+ 18 - 5
docs/database/permissions.py

@@ -15,11 +15,22 @@ class Permissions():
 
     # DATA
     permission_type = (
+        "уникальный идентификатор определяющий наличие разрешения из множества "
+        "в словаре - выданных пользователю/клиенту/аккаунту"
     )
-    status = (
-    )
-    check_date = (
+    check_level = (
+        "(check-level из классификатора платформы) - информация об уровне "
+        "проверки. Проверка может быть проведена как платформой, так и "
+        "мета-сервисом, так и партнером мета-сервиса, а может быть и никем "
+        "(просто загружен). Указывается, так как достоверность проверки "
+        "разная. Экзамен, проверенный только на низком уровне, не принимается "
+        "во внимание как имеющийся до прохождения более "
+        "высокоуровневой проверки."
     )
+    status = "статус обработки заявки в системе заявок"
+
+    check_date = "timestamp проверки"
+    expire_date = "Срок окончания действия разрешения"
 
     # OTHER
     is_global = Template.is_global
@@ -27,10 +38,12 @@ class Permissions():
 
     # FK
     ticket_status = (
-        "id заявки, по которой происходит проверка статуса relationship. State меняется только в результате изменений в заявке."
+        "id заявки, по которой происходит проверка статуса relationship. "
+        "State меняется только в результате изменений в заявке."
     )
     user_id = (
-        "уникальный идентификатор пользователя/клиента/аккаунта, которым была пройдена проверка и получено разрешение"
+        "уникальный идентификатор пользователя/клиента/аккаунта, которым была "
+        "пройдена проверка и получено разрешение"
     )
     checked_by = (
         "userid проверившего"

+ 39 - 35
docs/database/provider.py

@@ -12,25 +12,32 @@ class Provider():
     id_metaservice = Template.id_metaservice
 
     # DATA
-    type = models.CharField(
-        max_length=150,
-        help_text="тип поставщика (партнер/ответственное лицо/поставщик услуг). Смысл такой - провайдер это статус пользователя, который, в зависимости от применения, может нести разный смысл и подразумевает под собой какой-то тип действия. Обычные исполнители - это провайдеры услуг (код 3). Ответственные за какое-то имущество, которые сдают его в аренду - это тоже провайдеры (код 2). Ответственные за набор услуг перед метасервисом (фактически - назначенные админы) - это провайдеры-партнеры (код 1)"
+    type = (
+        "тип поставщика (партнер/ответственное лицо/поставщик услуг). Смысл "
+        "такой - провайдер это статус пользователя, который, в зависимости от "
+        "применения, может нести разный смысл и подразумевает под собой "
+        "какой-то тип действия. Обычные исполнители - это провайдеры услуг "
+        "(код 3). Ответственные за какое-то имущество, которые сдают его в "
+        "аренду - это тоже провайдеры (код 2). Ответственные за набор услуг "
+        "перед метасервисом (фактически - назначенные админы) - это "
+        "провайдеры-партнеры (код 1)"
     )
-    requirements = models.CharField(
-        max_length=300,
-        help_text="требования для того, чтобы можно было предоставлять услуги любые в этом метасервисе в целом (самые строгие)"
+    requirements = (
+        "требования для того, чтобы можно было предоставлять услуги любые в "
+        "этом метасервисе в целом (самые строгие)"
     )
-    status = models.CharField(
-        max_length=150,
-        help_text="статус пользователя в системе относительно прохождения проверок (activity_status) (может быть active только в том случае, если ticket, влияющий на статус - закрыт."
+    status = (
+        "статус пользователя в системе относительно прохождения проверок "
+        "(activity_status) (может быть active только в том случае, если "
+        "ticket, влияющий на статус - закрыт."
     )
-    location_type = models.CharField(
-        max_length=300,
-        help_text="статическая или динамическая локация оказания услуги. Если статическая, а исполнитель находится существенно за пределами локации - то тогда статус автоматом оффлайн для приема новых заявок."
+    location_type = (
+        "статическая или динамическая локация оказания услуги. Если "
+        "статическая, а исполнитель находится существенно за пределами "
+        "локации - то тогда статус автоматом оффлайн для приема новых заявок."
     )
-    default_location = models.CharField(
-        max_length=300,
-        help_text="локация по умолчанию для объекта."
+    default_location = (
+        "локация по умолчанию для объекта."
     )
 
     # OTHER
@@ -38,27 +45,24 @@ class Provider():
     is_visible = Template.is_visible
 
     # FK
-    user_id = models.ForeignKey(
-        get_user_model(),
-        on_delete=models.DO_NOTHING,
-        null=True,
-        help_text="уникальный идентификатор конкретного пользователя системы (meta-user), который будет оказывать услугу. Один пользователь может быть провайдером нескольких услуг. Статус провайдера означает, что с данным пользователем может быть установлена связь, как с исполнителем."
+    user_id = (
+        "уникальный идентификатор конкретного пользователя системы "
+        "(meta-user), который будет оказывать услугу. Один пользователь может "
+        "быть провайдером нескольких услуг. Статус провайдера означает, что с "
+        "данным пользователем может быть установлена связь, как с исполнителем."
     )
-    company_id = models.ForeignKey(
-        Company,
-        on_delete=models.DO_NOTHING,
-        null=True,
-        help_text="уникальный идентификатор компании, от лица которой выступает провайдер. Смысл такой - ответственны могут быть только одушевленные лица, компании - не одушевленные. Все услуги предоставляются через компании-партнеры, самозанятые или ИП являются единицами таких компаний."
+    company_id = (
+        "уникальный идентификатор компании, от лица которой выступает "
+        "провайдер. Смысл такой - ответственны могут быть только одушевленные "
+        "лица, компании - не одушевленные. Все услуги предоставляются через "
+        "компании-партнеры, самозанятые или ИП являются единицами "
+        "таких компаний."
     )
-    ticket_status = models.ForeignKey(
-        Ticket,
-        on_delete=models.DO_NOTHING,
-        null=True,
-        help_text="id последнего актуального тикета, касающийся статуса. Если он меняет статус на закрытый - вызывается проверка, которая смотрит, нет ли другого открытого по пользователю."
+    ticket_status = (
+        "id последнего актуального тикета, касающийся статуса. Если он меняет "
+        "статус на закрытый - вызывается проверка, которая смотрит, нет ли "
+        "другого открытого по пользователю."
     )
-    service = models.ForeignKey(
-        Service,
-        on_delete=models.DO_NOTHING,
-        null=True,
-        help_text="id услуги, которую предостовляют"
+    service = (
+        "id услуги, которую предостовляют"
     )