Skip to content

Data Validation Engine API Package

nautobot_data_validation_engine.api

REST API module for nautobot_data_validation_engine plugin.

nested_serializers

API serializers.

NestedMinMaxValidationRuleSerializer

Bases: WritableNestedSerializer

Serializer for MinMaxValidationRule objects.

Source code in nautobot_data_validation_engine/api/nested_serializers.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
class NestedMinMaxValidationRuleSerializer(WritableNestedSerializer):
    """Serializer for `MinMaxValidationRule` objects."""

    url = serializers.HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_data_validation_engine-api:minmaxvalidationrule-detail"
    )

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

        model = MinMaxValidationRule
        fields = [
            "id",
            "url",
            "name",
            "slug",
        ]
Meta

Serializer metadata for MinMaxValidationRule objects.

Source code in nautobot_data_validation_engine/api/nested_serializers.py 
49
50
51
52
53
54
55
56
57
58
class Meta:
    """Serializer metadata for MinMaxValidationRule objects."""

    model = MinMaxValidationRule
    fields = [
        "id",
        "url",
        "name",
        "slug",
    ]

NestedRegularExpressionValidationRuleSerializer

Bases: WritableNestedSerializer

Serializer for RegularExpressionValidationRule objects.

Source code in nautobot_data_validation_engine/api/nested_serializers.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class NestedRegularExpressionValidationRuleSerializer(WritableNestedSerializer):
    """Serializer for `RegularExpressionValidationRule` objects."""

    url = serializers.HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_data_validation_engine-api:regularexpressionvalidationrule-detail"
    )

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

        model = RegularExpressionValidationRule
        fields = [
            "id",
            "url",
            "name",
            "slug",
        ]
Meta

Serializer metadata for RegularExpressionValidationRule objects.

Source code in nautobot_data_validation_engine/api/nested_serializers.py 
30
31
32
33
34
35
36
37
38
39
class Meta:
    """Serializer metadata for RegularExpressionValidationRule objects."""

    model = RegularExpressionValidationRule
    fields = [
        "id",
        "url",
        "name",
        "slug",
    ]

NestedRequiredValidationRuleSerializer

Bases: WritableNestedSerializer

Serializer for RequiredValidationRule objects.

Source code in nautobot_data_validation_engine/api/nested_serializers.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
class NestedRequiredValidationRuleSerializer(WritableNestedSerializer):
    """Serializer for `RequiredValidationRule` objects."""

    url = serializers.HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_data_validation_engine-api:requiredvalidationrule-detail"
    )

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

        model = RequiredValidationRule
        fields = [
            "id",
            "url",
            "name",
            "slug",
        ]
Meta

Serializer metadata for RequiredValidationRule objects.

Source code in nautobot_data_validation_engine/api/nested_serializers.py 
68
69
70
71
72
73
74
75
76
77
class Meta:
    """Serializer metadata for RequiredValidationRule objects."""

    model = RequiredValidationRule
    fields = [
        "id",
        "url",
        "name",
        "slug",
    ]

NestedUniqueValidationRuleSerializer

Bases: WritableNestedSerializer

Serializer for UniqueValidationRule objects.

Source code in nautobot_data_validation_engine/api/nested_serializers.py 
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
class NestedUniqueValidationRuleSerializer(WritableNestedSerializer):
    """Serializer for `UniqueValidationRule` objects."""

    url = serializers.HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_data_validation_engine-api:uniquevalidationrule-detail"
    )

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

        model = UniqueValidationRule
        fields = [
            "id",
            "url",
            "name",
            "slug",
        ]
Meta

Serializer metadata for UniqueValidationRule objects.

Source code in nautobot_data_validation_engine/api/nested_serializers.py 
87
88
89
90
91
92
93
94
95
96
class Meta:
    """Serializer metadata for UniqueValidationRule objects."""

    model = UniqueValidationRule
    fields = [
        "id",
        "url",
        "name",
        "slug",
    ]

serializers

API serializers.

DataComplianceSerializer

Bases: NautobotModelSerializer

Serializer for DataCompliance.

Source code in nautobot_data_validation_engine/api/serializers.py 
145
146
147
148
149
150
151
152
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 
148
149
150
151
152
class Meta:
    """Meta class for serializer."""

    model = DataCompliance
    fields = "__all__"

MinMaxValidationRuleSerializer

Bases: NautobotModelSerializer

Serializer for MinMaxValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class MinMaxValidationRuleSerializer(NautobotModelSerializer):
    """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 = [
            "id",
            "url",
            "name",
            "slug",
            "content_type",
            "field",
            "min",
            "max",
            "enabled",
            "error_message",
            "created",
            "last_updated",
        ]
Meta

Serializer metadata for MinMaxValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class Meta:
    """Serializer metadata for MinMaxValidationRule objects."""

    model = MinMaxValidationRule
    fields = [
        "id",
        "url",
        "name",
        "slug",
        "content_type",
        "field",
        "min",
        "max",
        "enabled",
        "error_message",
        "created",
        "last_updated",
    ]

RegularExpressionValidationRuleSerializer

Bases: NautobotModelSerializer

Serializer for RegularExpressionValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
class RegularExpressionValidationRuleSerializer(NautobotModelSerializer):
    """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 = [
            "id",
            "url",
            "name",
            "slug",
            "content_type",
            "field",
            "regular_expression",
            "context_processing",
            "enabled",
            "error_message",
            "created",
            "last_updated",
        ]
Meta

Serializer metadata for RegularExpressionValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
class Meta:
    """Serializer metadata for RegularExpressionValidationRule objects."""

    model = RegularExpressionValidationRule
    fields = [
        "id",
        "url",
        "name",
        "slug",
        "content_type",
        "field",
        "regular_expression",
        "context_processing",
        "enabled",
        "error_message",
        "created",
        "last_updated",
    ]

RequiredValidationRuleSerializer

Bases: NautobotModelSerializer

Serializer for RequiredValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
class RequiredValidationRuleSerializer(NautobotModelSerializer):
    """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 = [
            "id",
            "url",
            "name",
            "slug",
            "content_type",
            "field",
            "enabled",
            "error_message",
            "created",
            "last_updated",
        ]
Meta

Serializer metadata for RequiredValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
class Meta:
    """Serializer metadata for RequiredValidationRule objects."""

    model = RequiredValidationRule
    fields = [
        "id",
        "url",
        "name",
        "slug",
        "content_type",
        "field",
        "enabled",
        "error_message",
        "created",
        "last_updated",
    ]

UniqueValidationRuleSerializer

Bases: NautobotModelSerializer

Serializer for UniqueValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
class UniqueValidationRuleSerializer(NautobotModelSerializer):
    """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 = [
            "id",
            "url",
            "name",
            "slug",
            "content_type",
            "field",
            "max_instances",
            "enabled",
            "error_message",
            "created",
            "last_updated",
        ]
Meta

Serializer metadata for UniqueValidationRule objects.

Source code in nautobot_data_validation_engine/api/serializers.py 
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
class Meta:
    """Serializer metadata for UniqueValidationRule objects."""

    model = UniqueValidationRule
    fields = [
        "id",
        "url",
        "name",
        "slug",
        "content_type",
        "field",
        "max_instances",
        "enabled",
        "error_message",
        "created",
        "last_updated",
    ]

urls

API routes.

views

API views.

DataComplianceAPIView

Bases: NautobotModelViewSet

API Views for DataCompliance.

Source code in nautobot_data_validation_engine/api/views.py 
51
52
53
54
55
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 
11
12
13
14
15
16
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 
14
15
16
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 
27
28
29
30
31
32
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 
19
20
21
22
23
24
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 
35
36
37
38
39
40
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 
43
44
45
46
47
48
class UniqueValidationRuleViewSet(NautobotModelViewSet):
    """View to manage min max expression validation rules."""

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