diff --git a/apps/collection/views/back.py b/apps/collection/views/back.py index 5f5088ab..e5ddab58 100644 --- a/apps/collection/views/back.py +++ b/apps/collection/views/back.py @@ -118,7 +118,7 @@ class GuideListCreateView(GuideBaseView, generics.ListCreateAPIView): ### Response Return paginated list of guides. - I.e.: + E.g.: ``` { "count": 58, diff --git a/apps/establishment/serializers/back.py b/apps/establishment/serializers/back.py index 32784875..e6d4e819 100644 --- a/apps/establishment/serializers/back.py +++ b/apps/establishment/serializers/back.py @@ -15,7 +15,7 @@ from establishment import models, serializers as model_serializers from establishment.models import ContactEmail, ContactPhone, EstablishmentEmployee from establishment.serializers.common import ContactPhonesSerializer from gallery.models import Image -from location.serializers import AddressDetailSerializer, TranslatedField, AddressBaseSerializer +from location.serializers import AddressDetailSerializer, TranslatedField from main import models as main_models from main.models import Currency from main.serializers import AwardSerializer @@ -529,10 +529,8 @@ class EstEmployeeBackSerializer(EmployeeBackSerializers): 'toque_number', 'available_for_events', 'photo', + 'photo_id', ] - extra_kwargs = { - 'phone': {'write_only': True} - } class EstablishmentBackOfficeGallerySerializer(serializers.ModelSerializer): diff --git a/apps/establishment/views/back.py b/apps/establishment/views/back.py index 4fd42271..325638bb 100644 --- a/apps/establishment/views/back.py +++ b/apps/establishment/views/back.py @@ -531,17 +531,18 @@ class EmployeeListCreateView(generics.ListCreateAPIView): #### Request Required fields: - * available_for_events (bool) - flag that responds for availability for events + * name (`str`) - employee name Non-required fields: - * name (`str`) - name - * last_name (`str`) - last name + * name (`str`) - employee name + * last_name (`str`) - employee last name * user (`int`) - user identifier * sex (`int`) - enum: `0 (Male), 1 (Female)` * birth_date (`str`) - birth datetime (datetime in a format `ISO-8601`) * email (`str`) - email address * phone (`str`) - phone number in a format `E164` * photo_id (`int`) - photo identifier + * available_for_events (bool) - flag that responds for availability for events """ filter_class = filters.EmployeeBackFilter serializer_class = serializers.EmployeeBackSerializers @@ -590,7 +591,47 @@ class EmployeesListSearchViews(generics.ListAPIView): class EstablishmentEmployeeListView(generics.ListCreateAPIView): - """Establishment employees list view.""" + """ + ## Establishment employees List/Create view. + ### *GET* + #### Description + Returning non-paginated list of employees by establishment identifier. + ##### Response + E.g.: + ``` + [ + { + "id": 1, + ... + } + ] + ``` + + ### *POST* + #### Description + Create a new instance of employee for establishment by establishment identifier. + #### Request + Required: + * name (`str`) - employee name + + Additional: + * last_name (`str`) - employee last name + * user (`int`) - user identifier + * sex (`int`) - enum: `0 (Male), 1 (Female)` + * birth_date (`str`) - birth datetime (datetime in a format `ISO-8601`) + * email (`str`) - email address + * phone (`str`) - phone number in a format `E164` + * available_for_events (bool) - flag that responds for availability for events + * photo_id (`int`) - photo identifier + + #### Response + ``` + { + "id": 1, + ... + } + ``` + """ serializer_class = serializers.EstEmployeeBackSerializer pagination_class = None permission_classes = get_permission_classes( @@ -613,7 +654,8 @@ class EmployeeRUDView(generics.RetrieveUpdateDestroyAPIView): """ ## Employee Retrieve/Update/Destroy view ### *GET* - #### Retrieve a serialized object of employee. + #### Description + Retrieve a serialized object of employee. ##### Response ``` { @@ -638,7 +680,7 @@ class EmployeeRUDView(generics.RetrieveUpdateDestroyAPIView): * photo_id (`int`) - image identifier ##### Response Return an employee serialized object - I.e.: + E.g.: ``` { "id": 1, @@ -651,7 +693,7 @@ class EmployeeRUDView(generics.RetrieveUpdateDestroyAPIView): Delete an instance of employee ##### Response ``` - No response data + No content ``` """ serializer_class = serializers.EmployeeBackSerializers @@ -663,6 +705,16 @@ class EmployeeRUDView(generics.RetrieveUpdateDestroyAPIView): class RemoveAwardView(generics.DestroyAPIView): + """ + ## Remove award view. + ### *DELETE* + #### Description + Remove an award from an employee by an employee identifier and an award identifier. + ##### Response + ``` + No content + ``` + """ lookup_field = 'pk' serializer_class = serializers.EmployeeBackSerializers queryset = models.Employee.objects.with_back_office_related() @@ -923,7 +975,25 @@ class EstablishmentPositionListView(generics.ListAPIView): class EstablishmentAdminView(generics.ListAPIView): - """Establishment admin list view.""" + """ + ## List establishment admins + ### *GET* + #### Description + Returning paginated list of establishment administrators by establishment slug. + ##### Response + ``` + { + "count": 58, + "next": 2, + "previous": null, + "results": [ + { + "id": 1, + ... + } + ] + } +``` """ serializer_class = serializers.EstablishmentAdminListSerializer permission_classes = get_permission_classes( IsEstablishmentManager, diff --git a/apps/report/views/back.py b/apps/report/views/back.py index 6735a3c2..993507dc 100644 --- a/apps/report/views/back.py +++ b/apps/report/views/back.py @@ -13,7 +13,7 @@ class ReportListCreateView(ReportBaseView, ListCreateAPIView): * category: integer (0 - Bug, 1 - Suggestion improvement) * url: char (URL) * description: text (problem description) - I.e.: + E.g.: ``` { "category": 1, diff --git a/apps/report/views/common.py b/apps/report/views/common.py index 40b155bf..5fff213b 100644 --- a/apps/report/views/common.py +++ b/apps/report/views/common.py @@ -38,7 +38,7 @@ class ReportRetrieveView(ReportBaseView, generics.RetrieveAPIView): ## View for retrieving serialized instance. ### Response Return serialized object. - I.e.: + E.g.: ``` { "count": 7, diff --git a/apps/report/views/web.py b/apps/report/views/web.py index 95477a21..6f1dfbfc 100644 --- a/apps/report/views/web.py +++ b/apps/report/views/web.py @@ -13,7 +13,7 @@ class ReportListCreateView(ReportBaseView, ListCreateAPIView): * category: integer (0 - Bug, 1 - Suggestion improvement) * url: char (URL) * description: text (problem description) - I.e.: + E.g.: ``` { "category": 1, diff --git a/project/templates/report/tech_support_template.html b/project/templates/report/tech_support_template.html new file mode 100644 index 00000000..40b8f465 --- /dev/null +++ b/project/templates/report/tech_support_template.html @@ -0,0 +1,49 @@ + + + + + + + + + Tech Support + + + +
+
+ +
+
+ + New technical + request has been created +
+
+

+ Source: %source_value% +

+

Source page: %source_page_url%

+

User language: %source_screen_language%

+

Request category: %request_category% Request %request_description%

+
+
+

$support.email.note$

+
+
+ + + \ No newline at end of file