announcements.api.v1 package

Submodules

announcements.api.v1.serializers module

DRF serializers defined by the announcements package.

class announcements.api.v1.serializers.SlideSerializer(*args, **kwargs)

Bases: rest_framework.serializers.ModelSerializer

Slide serializer.

class Meta

Bases: object

Meta class for the serializer.

fields = ('pk', 'title', 'content', 'order', 'url')

model

alias of announcements.models.Slide

announcements.api.v1.urls module

DRF routes defined by the announcements package.

announcements.api.v1.viewsets module

class announcements.api.v1.viewsets.SlideViewset(**kwargs)

Bases: rest_framework.viewsets.ReadOnlyModelViewSet

Viewset for slides.

basename = None

description = None

detail = None

get_queryset()

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

name = None

queryset

serializer_class

alias of announcements.api.v1.serializers.SlideSerializer

suffix = None