Single Source of Truth API Package

nautobot_ssot.api

REST API module for nautobot_ssot app.

serializers

Django API serializers for nautobot_ssot app.

SyncLogEntrySerializer

Bases: NautobotModelSerializer

SyncLogEntry Serializer.

Source code in nautobot_ssot/api/serializers.py

class SyncLogEntrySerializer(NautobotModelSerializer):  # pylint: disable=too-many-ancestors
    """SyncLogEntry Serializer."""

    class Meta:
        """Meta attributes."""

        model = models.SyncLogEntry
        fields = "__all__"

Meta

Meta attributes.

Source code in nautobot_ssot/api/serializers.py

class Meta:
    """Meta attributes."""

    model = models.SyncLogEntry
    fields = "__all__"

SyncSerializer

Bases: NautobotModelSerializer

Sync Serializer.

Source code in nautobot_ssot/api/serializers.py

class SyncSerializer(NautobotModelSerializer):  # pylint: disable=too-many-ancestors
    """Sync Serializer."""

    class Meta:
        """Meta attributes."""

        model = models.Sync
        fields = "__all__"

Meta

Meta attributes.

Source code in nautobot_ssot/api/serializers.py

class Meta:
    """Meta attributes."""

    model = models.Sync
    fields = "__all__"

urls

Django API urlpatterns declaration for nautobot_ssot app.

views

API views for nautobot_ssot.

SyncLogEntryViewSet

Bases: NautobotModelViewSet

SyncLogEntry viewset.

Source code in nautobot_ssot/api/views.py

class SyncLogEntryViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
    """SyncLogEntry viewset."""

    queryset = models.SyncLogEntry.objects.all()
    serializer_class = serializers.SyncLogEntrySerializer
    filterset_class = filters.SyncLogEntryFilterSet

SyncViewSet

Bases: NautobotModelViewSet

Sync viewset.

Source code in nautobot_ssot/api/views.py

class SyncViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
    """Sync viewset."""

    queryset = models.Sync.objects.all()
    serializer_class = serializers.SyncSerializer
    filterset_class = filters.SyncFilterSet