announcements.api.v2 package

Submodules

announcements.api.v2.serializers module

DRF serializers defined by the announcements package.

class announcements.api.v2.serializers.FrontpageArticleSerializer(*args, **kwargs)

Bases: rest_framework.serializers.ModelSerializer

FrontpageArticle serializer.

class Meta

Bases: object

Meta class for the serializer.

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

model

alias of announcements.models.Slide

class announcements.api.v2.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.v2.urls module

Announcements app API v2 urls.

announcements.api.v2.views module

API v2 views of the announcements app.

class announcements.api.v2.views.AnnouncementsAPIViewMixin

Bases: object

permission_classes = [<class 'oauth2_provider.contrib.rest_framework.permissions.IsAuthenticatedOrTokenHasScope'>, <class 'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'>]

required_scopes = ['announcements:read']

class announcements.api.v2.views.FrontpageArticleDetailView(**kwargs)

Bases: announcements.api.v2.views.AnnouncementsAPIViewMixin, rest_framework.generics.RetrieveAPIView

Returns details of a frontpage article.

queryset

serializer_class

alias of announcements.api.v2.serializers.FrontpageArticleSerializer

class announcements.api.v2.views.FrontpageArticleListView(**kwargs)

Bases: announcements.api.v2.views.AnnouncementsAPIViewMixin, rest_framework.generics.ListAPIView

Returns an overview of all frontpage articles that are currently active.

queryset

serializer_class

alias of announcements.api.v2.serializers.FrontpageArticleSerializer

class announcements.api.v2.views.SlideDetailView(**kwargs)

Bases: announcements.api.v2.views.AnnouncementsAPIViewMixin, rest_framework.generics.RetrieveAPIView

Returns details of a slide.

queryset

serializer_class

alias of announcements.api.v2.serializers.SlideSerializer

class announcements.api.v2.views.SlideListView(**kwargs)

Bases: announcements.api.v2.views.AnnouncementsAPIViewMixin, rest_framework.generics.ListAPIView

Returns an overview of all slides that are currently active.

queryset

serializer_class

alias of announcements.api.v2.serializers.SlideSerializer