Skip to content

Data Validation Engine API Package

nautobot_data_validation_engine.api

serializers

API serializers

MinMaxValidationRuleSerializer

Bases: ValidatedModelSerializer

Serializer for MinMaxValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
class MinMaxValidationRuleSerializer(ValidatedModelSerializer):
    """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:
        model = MinMaxValidationRule
        fields = [
            "id",
            "url",
            "name",
            "slug",
            "content_type",
            "field",
            "min",
            "max",
            "enabled",
            "error_message",
            "created",
            "last_updated",
        ]

RegularExpressionValidationRuleSerializer

Bases: ValidatedModelSerializer

Serializer for RegularExpressionValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class RegularExpressionValidationRuleSerializer(ValidatedModelSerializer):
    """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:
        model = RegularExpressionValidationRule
        fields = [
            "id",
            "url",
            "name",
            "slug",
            "content_type",
            "field",
            "regular_expression",
            "enabled",
            "error_message",
            "created",
            "last_updated",
        ]

urls

API routes

views

API views

DataValidationEngineRootView

Bases: APIRootView

Data Validation Engine API root view

Source code in nautobot_data_validation_engine/api/views.py 
12
13
14
15
16
17
18
class DataValidationEngineRootView(APIRootView):
    """
    Data Validation Engine API root view
    """

    def get_view_name(self):
        return "Data Validation Engine"

MinMaxValidationRuleViewSet

Bases: ModelViewSet

View to manage min max expression validation rules

Source code in nautobot_data_validation_engine/api/views.py 
31
32
33
34
35
36
37
38
class MinMaxValidationRuleViewSet(ModelViewSet):
    """
    View to manage min max expression validation rules
    """

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

RegularExpressionValidationRuleViewSet

Bases: ModelViewSet

View to manage regular expression validation rules

Source code in nautobot_data_validation_engine/api/views.py 
21
22
23
24
25
26
27
28
class RegularExpressionValidationRuleViewSet(ModelViewSet):
    """
    View to manage regular expression validation rules
    """

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