Commit c2f30b56 authored by Joel Collins's avatar Joel Collins
Browse files

Updated docs for new download method

parent e98552a6

openflexure_microscope/api/v1.py

+4 −2
Original line number Diff line number Diff line
@@ -495,10 +495,12 @@ class CaptureDownloadAPI(MicroscopeView): 
        Return image data for a capture.



        If no (filename) is specified, the request will redirect to download the capture 

        under it's currently set filename.

        under it's currently set filename. I.e., `/(capture_id)/download` will 

        redirect to `/(capture_id)/download/(filename)`.



        If (filename) is specified, the capture data will be returned as an image 

        file with the requested filename.

        file with the requested filename. I.e., `/(capture_id)/download/foo.jpeg` will

        download the image as `foo.jpeg`, regardless of the capture's initially set filename.



        .. :quickref: Capture; Download capture file