From 82e7262fdfe42b965cb47d6e83379bbd982abe23 Mon Sep 17 00:00:00 2001 From: Anatoly Date: Fri, 7 Feb 2020 15:27:23 +0300 Subject: [PATCH] modified documentation strings for creating establishment schedule --- apps/establishment/views/back.py | 35 ++++++++++++++++++++++++++++---- apps/timetable/serialziers.py | 5 ----- 2 files changed, 31 insertions(+), 9 deletions(-) diff --git a/apps/establishment/views/back.py b/apps/establishment/views/back.py index 3f0b635b..92e2f631 100644 --- a/apps/establishment/views/back.py +++ b/apps/establishment/views/back.py @@ -210,7 +210,7 @@ class EstablishmentRUDView(EstablishmentMixinViews, generics.RetrieveUpdateDestr ) def get_queryset(self): - """Overridden get_queryset method.""" + """An overridden get_queryset method.""" qs = super(EstablishmentRUDView, self).get_queryset() return qs.prefetch_related( 'establishmentemployee_set', @@ -271,9 +271,36 @@ class EstablishmentScheduleRUDView(EstablishmentMixinViews, generics.RetrieveUpd class EstablishmentScheduleCreateView(generics.CreateAPIView): """ - Establishment schedule Create view - - Implement creating Establishment shedule. + ## Create establishment schedule + ### *POST* + #### Description + Create schedule for establishment by establishment `slug`. + ##### Request + Required: + * weekday (`enum`) + ``` + 0 (Monday), + 1 (Tuesday), + 2 (Wednesday), + 3 (Thursday), + 4 (Friday), + 5 (Saturday), + 6 (Sunday) + ``` + Non-required: + * lunch_start (str) - time in a format (`ISO-8601`, e.g. - `hh:mm:ss`) + * lunch_end (str) - time in a format (`ISO-8601`, e.g. - `hh:mm:ss`) + * dinner_start (str) - time in a format (`ISO-8601`, e.g. - `hh:mm:ss`) + * dinner_end (str) - time in a format (`ISO-8601`, e.g. - `hh:mm:ss`) + * opening_at (str) - time in a format (`ISO-8601`, e.g. - `hh:mm:ss`) + * closed_at (str) - time in a format (`ISO-8601`, e.g. - `hh:mm:ss`) + ##### Response + ``` + { + "id": 1, + ... + } + ``` """ lookup_field = 'slug' serializer_class = ScheduleCreateSerializer diff --git a/apps/timetable/serialziers.py b/apps/timetable/serialziers.py index a3183543..a23de288 100644 --- a/apps/timetable/serialziers.py +++ b/apps/timetable/serialziers.py @@ -1,7 +1,5 @@ """Serializer for app timetable""" -import datetime - from django.utils.translation import gettext_lazy as _ from rest_framework import serializers @@ -23,8 +21,6 @@ class ScheduleRUDSerializer(serializers.ModelSerializer): dinner_end = serializers.TimeField(required=False) opening_at = serializers.TimeField(required=False) closed_at = serializers.TimeField(required=False) - # For permission!! - establishment_id = serializers.ReadOnlyField(source='establishment.id') class Meta: """Meta class.""" @@ -40,7 +36,6 @@ class ScheduleRUDSerializer(serializers.ModelSerializer): 'dinner_end', 'opening_at', 'closed_at', - 'establishment_id' ] def validate(self, attrs):