modified documentation strings for creating establishment schedule

This commit is contained in:
Anatoly 2020-02-07 15:27:23 +03:00
parent 6421efed62
commit 82e7262fdf
2 changed files with 31 additions and 9 deletions

View File

@ -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

View File

@ -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):