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

Fixed response descriptions for stream/RAM capture

Browse source
This commit is contained in:
Richard 2021-07-06 15:24:43 +01:00
parent c81c4eb64d
commit 00531a93bf
2 changed files with 24 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
openflexure_microscope/api/v2/views/actions/camera.py
View file

@ -66,12 +66,15 @@ class CaptureAPI(ActionView):
class RAMCaptureAPI(ActionView):
"""
Take a non-persistant image capture.
"""
"""Take a non-persistent image capture."""
args = BasicCaptureArgs()
responses = {200: {"content_type": "image/jpeg"}}
responses = {
200: {
"content_type": "image/jpeg",
"description": "A JPEG image, representing the capture"
}
}
def post(self, args):
"""

18
openflexure_microscope/api/v2/views/streams.py
View file

@ -17,7 +17,23 @@ class MjpegStream(PropertyView):
Real-time MJPEG stream from the microscope camera
"""
responses = {200: {"content_type": "multipart/x-mixed-replace"}}
responses = {
200: {
"content_type": "multipart/x-mixed-replace",
"description": (
"An MJPEG stream of camera images.\n\n"
"This endpoint will serve JPEG images sequentially, \n"
"with each frame separated by `--frame` and a \n"
"`Content-Type: image/jpeg` header.\n"
"Using this endpoint as the `src` of an HTML `<img>` \n"
"tag will result in the video stream displaying without \n"
"further effort.\n\n"
"If you save the stream to disk (e.g. with `curl`), be \n"
"aware that the text in between frames may confuse some \n"
"video players."
),
}
}
def get(self):
"""