From c2f30b56c3cce6eb7c8d22bfd24fc38c6aa1b124 Mon Sep 17 00:00:00 2001 From: Joel Collins Date: Tue, 20 Nov 2018 16:19:17 +0000 Subject: [PATCH] Updated docs for new download method --- openflexure_microscope/api/v1.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/openflexure_microscope/api/v1.py b/openflexure_microscope/api/v1.py index 99ad1c96..01279202 100644 --- a/openflexure_microscope/api/v1.py +++ b/openflexure_microscope/api/v1.py @@ -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