Data Validation Engine API Package

nautobot_data_validation_engine.api

REST API module for nautobot_data_validation_engine app.

serializers

API serializers.

DataComplianceSerializer

Bases: NautobotModelSerializer

Serializer for DataCompliance.

Source code in nautobot_data_validation_engine/api/serializers.py

class DataComplianceSerializer(NautobotModelSerializer):
    """Serializer for DataCompliance."""

    class Meta:
        """Meta class for serializer."""

        model = DataCompliance
        fields = "__all__"

Meta

Meta class for serializer.

Source code in nautobot_data_validation_engine/api/serializers.py

class Meta:
    """Meta class for serializer."""

    model = DataCompliance
    fields = "__all__"

MinMaxValidationRuleSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

Serializer for MinMaxValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py

class MinMaxValidationRuleSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """Serializer for `MinMaxValidationRule` objects."""

    url = serializers.HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_data_validation_engine-api:minmaxvalidationrule-detail"
    )
    content_type = ContentTypeField(
        queryset=ContentType.objects.filter(FeatureQuery("custom_validators").get_query()),
    )

    class Meta:
        """Serializer metadata for MinMaxValidationRule objects."""

        model = MinMaxValidationRule
        fields = "__all__"

Meta

Serializer metadata for MinMaxValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py

class Meta:
    """Serializer metadata for MinMaxValidationRule objects."""

    model = MinMaxValidationRule
    fields = "__all__"

RegularExpressionValidationRuleSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

Serializer for RegularExpressionValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py

class RegularExpressionValidationRuleSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """Serializer for `RegularExpressionValidationRule` objects."""

    url = serializers.HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_data_validation_engine-api:regularexpressionvalidationrule-detail"
    )
    content_type = ContentTypeField(
        queryset=ContentType.objects.filter(FeatureQuery("custom_validators").get_query()),
    )

    class Meta:
        """Serializer metadata for RegularExpressionValidationRule objects."""

        model = RegularExpressionValidationRule
        fields = "__all__"

Meta

Serializer metadata for RegularExpressionValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py

class Meta:
    """Serializer metadata for RegularExpressionValidationRule objects."""

    model = RegularExpressionValidationRule
    fields = "__all__"

RequiredValidationRuleSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

Serializer for RequiredValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py

class RequiredValidationRuleSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """Serializer for `RequiredValidationRule` objects."""

    url = serializers.HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_data_validation_engine-api:requiredvalidationrule-detail"
    )
    content_type = ContentTypeField(
        queryset=ContentType.objects.filter(FeatureQuery("custom_validators").get_query()),
    )

    class Meta:
        """Serializer metadata for RequiredValidationRule objects."""

        model = RequiredValidationRule
        fields = "__all__"

Meta

Serializer metadata for RequiredValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py

class Meta:
    """Serializer metadata for RequiredValidationRule objects."""

    model = RequiredValidationRule
    fields = "__all__"

UniqueValidationRuleSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

Serializer for UniqueValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py

class UniqueValidationRuleSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """Serializer for `UniqueValidationRule` objects."""

    url = serializers.HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_data_validation_engine-api:uniquevalidationrule-detail"
    )
    content_type = ContentTypeField(
        queryset=ContentType.objects.filter(FeatureQuery("custom_validators").get_query()),
    )

    class Meta:
        """Serializer metadata for UniqueValidationRule objects."""

        model = UniqueValidationRule
        fields = "__all__"

Meta

Serializer metadata for UniqueValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py

class Meta:
    """Serializer metadata for UniqueValidationRule objects."""

    model = UniqueValidationRule
    fields = "__all__"

urls

API routes.

views

API views.

DataComplianceAPIView

Bases: NautobotModelViewSet

API Views for DataCompliance.

Source code in nautobot_data_validation_engine/api/views.py

class DataComplianceAPIView(NautobotModelViewSet):
    """API Views for DataCompliance."""

    queryset = models.DataCompliance.objects.all()
    serializer_class = serializers.DataComplianceSerializer

DataValidationEngineRootView

Bases: APIRootView

Data Validation Engine API root view.

Source code in nautobot_data_validation_engine/api/views.py

class DataValidationEngineRootView(APIRootView):
    """Data Validation Engine API root view."""

    def get_view_name(self):
        """Get the name of the view."""
        return "Data Validation Engine"

get_view_name()

Get the name of the view.

Source code in nautobot_data_validation_engine/api/views.py

def get_view_name(self):
    """Get the name of the view."""
    return "Data Validation Engine"

MinMaxValidationRuleViewSet

Bases: NautobotModelViewSet

View to manage min max expression validation rules.

Source code in nautobot_data_validation_engine/api/views.py

class MinMaxValidationRuleViewSet(NautobotModelViewSet):
    """View to manage min max expression validation rules."""

    queryset = models.MinMaxValidationRule.objects.all()
    serializer_class = serializers.MinMaxValidationRuleSerializer
    filterset_class = filters.MinMaxValidationRuleFilterSet

RegularExpressionValidationRuleViewSet

Bases: NautobotModelViewSet

View to manage regular expression validation rules.

Source code in nautobot_data_validation_engine/api/views.py

class RegularExpressionValidationRuleViewSet(NautobotModelViewSet):
    """View to manage regular expression validation rules."""

    queryset = models.RegularExpressionValidationRule.objects.all()
    serializer_class = serializers.RegularExpressionValidationRuleSerializer
    filterset_class = filters.RegularExpressionValidationRuleFilterSet

RequiredValidationRuleViewSet

Bases: NautobotModelViewSet

View to manage min max expression validation rules.

Source code in nautobot_data_validation_engine/api/views.py

class RequiredValidationRuleViewSet(NautobotModelViewSet):
    """View to manage min max expression validation rules."""

    queryset = models.RequiredValidationRule.objects.all()
    serializer_class = serializers.RequiredValidationRuleSerializer
    filterset_class = filters.RequiredValidationRuleFilterSet

UniqueValidationRuleViewSet

Bases: NautobotModelViewSet

View to manage min max expression validation rules.

Source code in nautobot_data_validation_engine/api/views.py

class UniqueValidationRuleViewSet(NautobotModelViewSet):
    """View to manage min max expression validation rules."""

    queryset = models.UniqueValidationRule.objects.all()
    serializer_class = serializers.UniqueValidationRuleSerializer
    filterset_class = filters.UniqueValidationRuleFilterSet