From f42dcf8b953cdea4468b96607b12ba5aaf740a27 Mon Sep 17 00:00:00 2001
From: Joel Collins <joel@jtcollins.net>
Date: Tue, 4 Dec 2018 15:14:19 +0000
Subject: [PATCH] Docstring for preview API route

---
 openflexure_microscope/api/v1.py | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/openflexure_microscope/api/v1.py b/openflexure_microscope/api/v1.py
index edf936ba..ad67cb2c 100644
--- a/openflexure_microscope/api/v1.py
+++ b/openflexure_microscope/api/v1.py
@@ -653,7 +653,28 @@ class GPUPreviewAPI(MicroscopeView):
 
     def post(self, operation):
         """
-        TODO: Documentation
+        Create a new image capture.
+
+        .. :quickref: GPU Preview; Start/stop preview
+
+        **Example requests**:
+
+        .. sourcecode:: http
+
+          POST /camera/preview/start HTTP/1.1
+          Accept: application/json
+
+        :>header Accept: application/json
+
+        .. sourcecode:: http
+
+          POST /camera/preview/stop HTTP/1.1
+          Accept: application/json
+
+        :>header Accept: application/json
+
+        :<header Content-Type: application/json
+        :status 200: preview started/stopped
         """
         if operation == "start":
             self.microscope.camera.start_preview()