Skip to content

Operational Compliance API Package

nautobot_operational_compliance.api

REST API module for the nautobot_operational_compliance app.

serializers

serializer.

CommandOutputSerializer

Bases: NautobotModelSerializer

Serializer for API.

Source code in nautobot_operational_compliance/api/serializers.py 
39
40
41
42
43
44
45
46
47
48
class CommandOutputSerializer(NautobotModelSerializer):
    """Serializer for API."""

    device_name = serializers.CharField(source="device.name")

    class Meta:
        """Meta class for ValidationResult Serializer."""

        model = models.CommandOutput
        fields = "__all__"
Meta

Meta class for ValidationResult Serializer.

Source code in nautobot_operational_compliance/api/serializers.py 
44
45
46
47
48
class Meta:
    """Meta class for ValidationResult Serializer."""

    model = models.CommandOutput
    fields = "__all__"

CommandParserSerializer

Bases: NautobotModelSerializer

Serializer for API.

Source code in nautobot_operational_compliance/api/serializers.py 
29
30
31
32
33
34
35
36
class CommandParserSerializer(NautobotModelSerializer):
    """Serializer for API."""

    class Meta:
        """Meta class for CommandParser Serializer."""

        model = models.CommandParser
        fields = "__all__"
Meta

Meta class for CommandParser Serializer.

Source code in nautobot_operational_compliance/api/serializers.py 
32
33
34
35
36
class Meta:
    """Meta class for CommandParser Serializer."""

    model = models.CommandParser
    fields = "__all__"

ValidationResultSerializer

Bases: NautobotModelSerializer

Serializer for API.

Source code in nautobot_operational_compliance/api/serializers.py 
51
52
53
54
55
56
57
58
59
60
61
class ValidationResultSerializer(NautobotModelSerializer):
    """Serializer for API."""

    device = serializers.CharField(source="device.name")
    validation_rule = serializers.CharField(source="validation_rule.name")

    class Meta:
        """Meta class for ValidationResult Serializer."""

        model = models.ValidationResult
        fields = "__all__"
Meta

Meta class for ValidationResult Serializer.

Source code in nautobot_operational_compliance/api/serializers.py 
57
58
59
60
61
class Meta:
    """Meta class for ValidationResult Serializer."""

    model = models.ValidationResult
    fields = "__all__"

ValidationRuleGroupSerializer

Bases: NautobotModelSerializer

Serializer for API.

Source code in nautobot_operational_compliance/api/serializers.py 
19
20
21
22
23
24
25
26
class ValidationRuleGroupSerializer(NautobotModelSerializer):
    """Serializer for API."""

    class Meta:
        """Meta class for ValidationRuleGroupSerializer."""

        model = models.ValidationRuleGroup
        fields = "__all__"
Meta

Meta class for ValidationRuleGroupSerializer.

Source code in nautobot_operational_compliance/api/serializers.py 
22
23
24
25
26
class Meta:
    """Meta class for ValidationRuleGroupSerializer."""

    model = models.ValidationRuleGroup
    fields = "__all__"

ValidationRuleSerializer

Bases: NautobotModelSerializer

Serializer for API.

Source code in nautobot_operational_compliance/api/serializers.py 
 9
10
11
12
13
14
15
16
class ValidationRuleSerializer(NautobotModelSerializer):
    """Serializer for API."""

    class Meta:
        """Meta class for ValidationRuleSerializer."""

        model = models.ValidationRule
        fields = "__all__"
Meta

Meta class for ValidationRuleSerializer.

Source code in nautobot_operational_compliance/api/serializers.py 
12
13
14
15
16
class Meta:
    """Meta class for ValidationRuleSerializer."""

    model = models.ValidationRule
    fields = "__all__"

urls

API URLs.

views

API Views.

CommandOutputTaskView

Bases: NautobotModelViewSet

API view for CRUD CommandOutput operations.

Source code in nautobot_operational_compliance/api/views.py 
30
31
32
33
34
35
class CommandOutputTaskView(NautobotModelViewSet):
    """API view for CRUD CommandOutput operations."""

    filterset_class = filters.CommandOutputFilterSet
    queryset = CommandOutput.objects.all()
    serializer_class = CommandOutputSerializer

CommandParserTaskView

Bases: NautobotModelViewSet

API view for CRUD for Command parser operations.

Source code in nautobot_operational_compliance/api/views.py 
46
47
48
49
50
51
class CommandParserTaskView(NautobotModelViewSet):
    """API view for CRUD for Command parser operations."""

    filterset_class = filters.CommandParserFilterSet
    queryset = CommandParser.objects.all()
    serializer_class = CommandParserSerializer

ValidationResultTaskView

Bases: NautobotModelViewSet

API view for CRUD ValidationResult operations.

Source code in nautobot_operational_compliance/api/views.py 
38
39
40
41
42
43
class ValidationResultTaskView(NautobotModelViewSet):
    """API view for CRUD ValidationResult operations."""

    filterset_class = filters.ValidationResultFilterSet
    queryset = ValidationResult.objects.all()
    serializer_class = ValidationResultSerializer

ValidationRuleAPIView

Bases: NautobotModelViewSet

API view for CRUD ValidationRule operations.

Source code in nautobot_operational_compliance/api/views.py 
22
23
24
25
26
27
class ValidationRuleAPIView(NautobotModelViewSet):
    """API view for CRUD ValidationRule operations."""

    filterset_class = filters.ValidationRuleFilterSet
    queryset = ValidationRule.objects.all()
    serializer_class = ValidationRuleSerializer

ValidationRuleGroupTaskView

Bases: NautobotModelViewSet

API view for CRUD for Validation Rule Group operations.

Source code in nautobot_operational_compliance/api/views.py 
54
55
56
57
58
59
class ValidationRuleGroupTaskView(NautobotModelViewSet):
    """API view for CRUD for Validation Rule Group operations."""

    filterset_class = filters.ValidationRuleGroupFilterSet
    queryset = ValidationRuleGroup.objects.all()
    serializer_class = ValidationRuleGroupSerializer