Skip to content

views#

DownloadUnavailableException#

Bases: APIException

Source code in src/apps/download/views.py 
6
7
8
9
class DownloadUnavailableException(exceptions.APIException):
    status_code = 503
    default_detail = "Download service unavailable."
    default_code = "service_unavailable"

DownloadViewSet#

Bases: ViewSet

Source code in src/apps/download/views.py 
12
13
14
15
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
41
42
43
44
45
46
47
class DownloadViewSet(ViewSet):
    def not_implemented_detail(self, endpoint_detail):
        return f"{endpoint_detail} through Metax V3 not implemented."

    @action(detail=False, methods=["get", "post"])
    def packages(self, request):
        """Placeholder for getting available packages and requesting package generation from download service."""
        if request.method == "GET":
            raise DownloadUnavailableException(
                detail=self.not_implemented_detail("Getting available packages")
            )
        else:
            raise DownloadUnavailableException(
                detail=self.not_implemented_detail("Requesting package generation")
            )

    @action(detail=False, methods=["post"])
    def authorize(self, request):
        """Placeholder for authorizing a resource for download from download service."""
        raise DownloadUnavailableException(
            detail=self.not_implemented_detail("Resource authorization")
        )

    @action(detail=False, methods=["post"])
    def subscribe(self, request):
        """Placeholder for subscribing to an email notification from download service when package creation is ready."""
        raise DownloadUnavailableException(
            detail=self.not_implemented_detail("Package subscriptions")
        )

    @action(detail=False, methods=["post"])
    def notifications(self, request):
        """Placeholder for sending package ready -notification to a subscriber"""
        raise DownloadUnavailableException(
            detail=self.not_implemented_detail("Package notifications")
        )

authorize(request) #

Placeholder for authorizing a resource for download from download service.

Source code in src/apps/download/views.py 
28
29
30
31
32
33
@action(detail=False, methods=["post"])
def authorize(self, request):
    """Placeholder for authorizing a resource for download from download service."""
    raise DownloadUnavailableException(
        detail=self.not_implemented_detail("Resource authorization")
    )

notifications(request) #

Placeholder for sending package ready -notification to a subscriber

Source code in src/apps/download/views.py 
42
43
44
45
46
47
@action(detail=False, methods=["post"])
def notifications(self, request):
    """Placeholder for sending package ready -notification to a subscriber"""
    raise DownloadUnavailableException(
        detail=self.not_implemented_detail("Package notifications")
    )

packages(request) #

Placeholder for getting available packages and requesting package generation from download service.

Source code in src/apps/download/views.py 
16
17
18
19
20
21
22
23
24
25
26
@action(detail=False, methods=["get", "post"])
def packages(self, request):
    """Placeholder for getting available packages and requesting package generation from download service."""
    if request.method == "GET":
        raise DownloadUnavailableException(
            detail=self.not_implemented_detail("Getting available packages")
        )
    else:
        raise DownloadUnavailableException(
            detail=self.not_implemented_detail("Requesting package generation")
        )

subscribe(request) #

Placeholder for subscribing to an email notification from download service when package creation is ready.

Source code in src/apps/download/views.py 
35
36
37
38
39
40
@action(detail=False, methods=["post"])
def subscribe(self, request):
    """Placeholder for subscribing to an email notification from download service when package creation is ready."""
    raise DownloadUnavailableException(
        detail=self.not_implemented_detail("Package subscriptions")
    )