Improved documentation

This commit is contained in:
Joel Collins 2020-01-07 15:04:47 +00:00
parent a2bb1a1a38
commit ed13749abe
2 changed files with 44 additions and 27 deletions

View file

@ -25,13 +25,19 @@ class CaptureAPI(Resource):
@use_args(
{
"filename": fields.String(),
"temporary": fields.Boolean(missing=False),
"filename": fields.String(example="MyFileName"),
"temporary": fields.Boolean(
missing=False, description="Delete capture on shutdown"
),
"use_video_port": fields.Boolean(missing=False),
"bayer": fields.Boolean(missing=False),
"metadata": fields.Dict(missing={}),
"tags": fields.List(fields.String, missing=[]),
"resize": fields.Dict(missing=None), # TODO: Validate keys
"bayer": fields.Boolean(
missing=False, description="Store raw bayer data in file"
),
"metadata": fields.Dict(missing={}, example={"Client": "SwaggerUI"}),
"tags": fields.List(fields.String, missing=[], example=["docs"]),
"resize": fields.Dict(
missing=None, example={"width": 640, "height": 480}
), # TODO: Validate keys
}
)
@marshal_with(capture_schema)
@ -85,6 +91,9 @@ class GPUPreviewStartAPI(Resource):
"""
def post(self):
"""
Start the onboard GPU preview.
"""
microscope = find_device("openflexure_microscope")
payload = JsonResponse(request)
@ -104,11 +113,10 @@ class GPUPreviewStartAPI(Resource):
class GPUPreviewStopAPI(Resource):
"""
Start the onboard GPU preview.
"""
def post(self):
"""
Stop the onboard GPU preview.
"""
microscope = find_device("openflexure_microscope")
microscope.camera.stop_preview()
return jsonify(microscope.state)