Skip to content

Nautobot Version Control API Package

nautobot_version_control.api

serializers

serializers.py implements serializers for different modules.

BranchSerializer

Bases: ValidatedModelSerializer

BranchSerializer serializes a Branch

Source code in nautobot_version_control/api/serializers.py 
 6
 7
 8
 9
10
11
class BranchSerializer(ValidatedModelSerializer):
    """BranchSerializer serializes a Branch"""

    class Meta:
        model = Branch
        fields = "__all__"

CommitSerializer

Bases: ValidatedModelSerializer

CommitSerializer serializes a Commit

Source code in nautobot_version_control/api/serializers.py 
14
15
16
17
18
19
class CommitSerializer(ValidatedModelSerializer):
    """CommitSerializer serializes a Commit"""

    class Meta:
        model = Commit
        fields = "__all__"

PullRequestReviewSerializer

Bases: ValidatedModelSerializer

PullRequestReviewSerializer serializes a PullRequestReview

Source code in nautobot_version_control/api/serializers.py 
30
31
32
33
34
35
class PullRequestReviewSerializer(ValidatedModelSerializer):
    """PullRequestReviewSerializer serializes a PullRequestReview"""

    class Meta:
        model = PullRequestReview
        fields = "__all__"

PullRequestSerializer

Bases: ValidatedModelSerializer

PullRequestSerializer serializes a PullRequest

Source code in nautobot_version_control/api/serializers.py 
22
23
24
25
26
27
class PullRequestSerializer(ValidatedModelSerializer):
    """PullRequestSerializer serializes a PullRequest"""

    class Meta:
        model = PullRequest
        fields = "__all__"

urls

urls.py implements api urls.

views

views.py implements views for the api.

BranchViewSet

Bases: CustomFieldModelViewSet

BranchViewSet render a view for the Branch model.

Source code in nautobot_version_control/api/views.py 
25
26
27
28
29
30
class BranchViewSet(CustomFieldModelViewSet):
    """BranchViewSet render a view for the Branch model."""

    queryset = Branch.objects.all()
    serializer_class = serializers.BranchSerializer
    filterset_class = filters.BranchFilterSet

CommitViewSet

Bases: CustomFieldModelViewSet

CommitViewSet render a view for the Commit model.

Source code in nautobot_version_control/api/views.py 
38
39
40
41
42
43
class CommitViewSet(CustomFieldModelViewSet):
    """CommitViewSet render a view for the Commit model."""

    queryset = Commit.objects.all()
    serializer_class = serializers.CommitSerializer
    filterset_class = filters.CommitFilterSet

PullRequestReviewViewSet

Bases: CustomFieldModelViewSet

PullRequestReviewViewSet render a view for the PullRequestReviewV model.

Source code in nautobot_version_control/api/views.py 
64
65
66
67
68
69
class PullRequestReviewViewSet(CustomFieldModelViewSet):
    """PullRequestReviewViewSet render a view for the PullRequestReviewV model."""

    queryset = PullRequestReview.objects.all()
    serializer_class = serializers.PullRequestReviewSerializer
    filterset_class = filters.PullRequestReviewFilterSet

PullRequestViewSet

Bases: CustomFieldModelViewSet

PullRequestViewSet render a view for the PullRequest model.

Source code in nautobot_version_control/api/views.py 
51
52
53
54
55
56
class PullRequestViewSet(CustomFieldModelViewSet):
    """PullRequestViewSet render a view for the PullRequest model."""

    queryset = PullRequest.objects.all()
    serializer_class = serializers.PullRequestSerializer
    filterset_class = filters.PullRequestFilterSet

VCSRootView

Bases: APIRootView

VCS API root view.

Source code in nautobot_version_control/api/views.py 
12
13
14
15
16
17
class VCSRootView(APIRootView):
    """VCS API root view."""

    def get_view_name(self):
        """returns the name of the view."""
        return "VCS"
get_view_name()

returns the name of the view.

Source code in nautobot_version_control/api/views.py 
15
16
17
def get_view_name(self):
    """returns the name of the view."""
    return "VCS"