textify.api package

Subpackages

Submodules

textify.api.serializers module

class textify.api.serializers.NoteSerializer(*args, **kwargs)

Bases: rest_framework.serializers.ModelSerializer

Serializer for Note model

This class determines serialization of note object. The serialized fields are id, message and ``view_count, but only message is writeable, the other ones are read only fields.

class Meta

Bases: object

fields = ('id', 'message', 'view_count')
model

alias of textify.models.Note

read_only_fields = ('id', 'view_count')

textify.api.views module

class textify.api.views.NoteViewSet(**kwargs)

Bases: rest_framework.viewsets.ModelViewSet

Note model for storing notes

queryset

QuerySet that ModelViewSet require for operate on. Retrieved from db.

Type

QuerrySet

serializer_class

Serializer for model.

Type

NoteSerializer

permission_classes

List of permissions for authenticated requests.

Type

list of BasePermission

basename = None
description = None
detail = None
list(request, *args, **kwargs)

Override for ListModelMixin.

Note

It overrides default behavior of ListModelMixin.list() function. After GET request this function increase view_count of all messages. Then it calls default behavior of ListModelMixin.list()

Parameters

  • request – HTTP GET request for /api/v1/notes/.

  • *args – args

  • **kwargs – key-word args

Returns

ListModelMixin.list()

name = None
permission_classes = [<class 'rest_framework.permissions.IsAuthenticatedOrReadOnly'>]
queryset
retrieve(request, *args, **kwargs)

Override for RetrieveModelMixin.

Note

It overrides default behavior of RetrieveModelMixin.retrieve() function. After GET request this function increase view_count of message with specified id. Then it calls default behavior of RetrieveModelMixin.retrieve()

Parameters

  • request – HTTP GET request for /api/v1/notes/{number}/.

  • *args – args

  • **kwargs – key-word args

Returns

RetrieveModelMixin.retrieve()

serializer_class

alias of textify.api.serializers.NoteSerializer

suffix = None
update(request, *args, **kwargs)

Override for UpdateModelMixin.

Note

It overrides default behavior of UpdateModelMixin.update() function. After PUT request this function reset view_count of message with specified id. Then it calls default behavior of UpdateModelMixin.update()

Parameters

  • request – HTTP PUT request for /api/v1/notes/{number}/.

  • *args – args

  • **kwargs – key-word args

Returns

UpdateModelMixin.update()

Module contents