Skip to content

Welcome Wizard API Package

welcome_wizard.api

REST API module for Welcome Wizard plugin.

serializers

API Serializers for Welcome Wizard.

DeviceTypeImportSerializer

Bases: ModelSerializer

API serializer for interacting with DeviceTypeImport Objects.

Source code in welcome_wizard/api/serializers.py 
17
18
19
20
21
22
23
24
class DeviceTypeImportSerializer(ModelSerializer):
    """API serializer for interacting with DeviceTypeImport Objects."""

    class Meta:
        """Meta for DeviceTypeImport Serializer."""

        model = DeviceTypeImport
        fields = ("id", "name", "filename", "manufacturer")
Meta

Meta for DeviceTypeImport Serializer.

Source code in welcome_wizard/api/serializers.py 
20
21
22
23
24
class Meta:
    """Meta for DeviceTypeImport Serializer."""

    model = DeviceTypeImport
    fields = ("id", "name", "filename", "manufacturer")

ManufacturerImportSerializer

Bases: ModelSerializer

API serializer for interacting with ManufacturerImport objects.

Source code in welcome_wizard/api/serializers.py 
 7
 8
 9
10
11
12
13
14
class ManufacturerImportSerializer(ModelSerializer):
    """API serializer for interacting with ManufacturerImport objects."""

    class Meta:
        """Meta for ManufacturerImport Serializer."""

        model = ManufacturerImport
        fields = ("id", "name", "slug")
Meta

Meta for ManufacturerImport Serializer.

Source code in welcome_wizard/api/serializers.py 
10
11
12
13
14
class Meta:
    """Meta for ManufacturerImport Serializer."""

    model = ManufacturerImport
    fields = ("id", "name", "slug")

urls

API Urls for Welcome Wizard.

views

API Views for Welcome Wizard.

DeviceTypeViewSet

Bases: ModelViewSet

API viewset for interacting with DeviceTypeImport objects.

Source code in welcome_wizard/api/views.py 
15
16
17
18
19
class DeviceTypeViewSet(ModelViewSet):  # pylint: disable=too-many-ancestors
    """API viewset for interacting with DeviceTypeImport objects."""

    queryset = DeviceTypeImport.objects.all()
    serializer_class = DeviceTypeImportSerializer

ManufacturerViewSet

Bases: ModelViewSet

API viewset for interacting with ManufacturerImport objects.

Source code in welcome_wizard/api/views.py 
 8
 9
10
11
12
class ManufacturerViewSet(ModelViewSet):  # pylint: disable=too-many-ancestors
    """API viewset for interacting with ManufacturerImport objects."""

    queryset = ManufacturerImport.objects.all()
    serializer_class = ManufacturerImportSerializer