beat.web.dataformats.api module

class beat.web.dataformats.api.CheckDataFormatNameView(**kwargs)

Bases: beat.web.common.api.CheckContributionNameView

This view sanitizes a data format name and checks whether it is already used.

model

alias of beat.web.dataformats.models.DataFormat

class beat.web.dataformats.api.ShareDataFormatView(**kwargs)

Bases: beat.web.common.api.ShareView

This view allows to share a data format with other users and/or teams

model

alias of beat.web.dataformats.models.DataFormat

class beat.web.dataformats.api.ListDataFormatView(**kwargs)

Bases: beat.web.common.api.ListContributionView

List all available data formats

model

alias of beat.web.dataformats.models.DataFormat

serializer_class

alias of beat.web.dataformats.serializers.DataFormatSerializer

class beat.web.dataformats.api.ListCreateDataFormatsView(**kwargs)

Bases: beat.web.common.api.ListCreateContributionView

Read/Write end point that list the data formats available from a given author and allows the creation of new data formats

model

alias of beat.web.dataformats.models.DataFormat

serializer_class

alias of beat.web.dataformats.serializers.DataFormatSerializer

writing_serializer_class

alias of beat.web.dataformats.serializers.DataFormatCreationSerializer

namespace = 'api_dataformats'

class beat.web.dataformats.api.RetrieveUpdateDestroyDataFormatsView(**kwargs)

Bases: beat.web.common.api.RetrieveUpdateDestroyContributionView

Read/Write/Delete endpoint for a given data format

model

alias of beat.web.dataformats.models.DataFormat

serializer_class

alias of beat.web.dataformats.serializers.FullDataFormatSerializer

put(request, author_name, object_name, version=None)

class beat.web.dataformats.api.DiffDataFormatView(**kwargs)

Bases: beat.web.common.api.DiffView

This view shows the differences between two data formats

model

alias of beat.web.dataformats.models.DataFormat