rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated docs for new download method

Browse source
This commit is contained in:
Joel Collins 2018-11-20 16:19:17 +00:00
parent e98552a63d
commit c2f30b56c3
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
openflexure_microscope/api/v1.py
View file

@ -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