Fixed automatic Swagger from docstrings (5bdb6764) · Commits · OpenFlexure / openflexure-microscope-server

openflexure_microscope/api/v2/views/actions/camera.py

+3 −0

Original line number	Diff line number	Diff line
		@@ -30,6 +30,9 @@ class CaptureAPI(Resource):
		@marshal_with(capture_schema)
		@doc_response(200, "Capture successful")
		def post(self, args):
		"""
		Create a new capture
		"""
		microscope = find_device("openflexure_microscope")

		resize = args.get("resize", None)

openflexure_microscope/api/v2/views/streams.py

+1 −1

Original line number	Diff line number	Diff line
		@@ -15,7 +15,7 @@ class MjpegStream(Resource):

		def get(self):
		"""
		Real-time MJPEG stream from the microscope camera
		MJPEG stream from the microscope camera
		"""
		microscope = find_device("openflexure_microscope")
		# Restart stream worker thread

openflexure_microscope/common/flask_labthings/spec.py

+33 −21

Original line number	Diff line number	Diff line
		@@ -4,7 +4,7 @@ from .utilities import rupdate
		from apispec import APISpec
		from apispec.ext.marshmallow import MarshmallowPlugin

		from openflexure_microscope.common.labthings_core.utilities import get_docstring
		from openflexure_microscope.common.labthings_core.utilities import get_docstring, get_summary

		from .fields import Field
		from marshmallow import Schema as BaseSchema
		@@ -16,7 +16,7 @@ def view2path(rule: str, view: Resource, spec: APISpec):
		"path": rule, # TODO: Validate this slightly (leading / etc)
		"operations": view2operations(view, spec),
		"description": get_docstring(view),
		"summary": get_docstring(view).partition("\n")[0].strip()
		"summary": get_summary(view)
		}

		if hasattr(view, "__apispec__"):
		@@ -29,20 +29,28 @@ def view2operations(view: Resource, spec: APISpec, populate_default: bool = True
		ops = {}
		for method in Resource.methods:
		if hasattr(view, method):

		# Populate with default responses
		if populate_default:
		ops[method] = {
		"responses": {
		200: {
		"description": "success"
		}
		"description": get_summary(getattr(view, method)) or "Success"
		},
		404: {
		"description": "Resource not found"
		}
		},
		}
		else:
		ops[method] = {}

		rupdate(ops[method], {
		"description": get_docstring(getattr(view, method)),
		"summary": get_summary(getattr(view, method))
		})

		if hasattr(getattr(view, method), "__apispec__"):
		ops[method] = doc2operation(getattr(view, method).__apispec__, spec)
		rupdate(ops[method], doc2operation(getattr(view, method).__apispec__, spec))

		return ops

		@@ -50,18 +58,21 @@ def view2operations(view: Resource, spec: APISpec, populate_default: bool = True
		def doc2operation(apispec: dict, spec: APISpec):
		op = {}
		if "_params" in apispec:
		op["requestBody"] = {
		rupdate(op, {
		"requestBody": {
		"content": {
		"application/json": {
		"schema": convert_schema(apispec.get("_params"), spec)
		}
		},
		}
		}
		})

		if "_schema" in apispec:
		op["responses"] = {
		rupdate(op,
		{
		"responses": {
		200: {
		"description": "success",
		"content": {
		"application/json": {
		"schema": convert_schema(apispec.get("_schema"), spec)
		@@ -69,6 +80,7 @@ def doc2operation(apispec: dict, spec: APISpec):
		},
		}
		}
		})

		for key, val in apispec.items():
		if not key in ["_params", "_schema"]:

openflexure_microscope/common/flask_labthings/utilities.py

+2 −0

Original line number	Diff line number	Diff line
		@@ -22,6 +22,8 @@ def description_from_view(view_class):
		def rupdate(d, u):
		for k, v in u.items():
		if isinstance(v, collections.abc.Mapping):
		if not k in d:
		d[k] = {}
		d[k] = rupdate(d.get(k, {}), v)
		else:
		d[k] = v

openflexure_microscope/common/labthings_core/utilities.py

+3 −0

Original line number	Diff line number	Diff line
		@@ -4,3 +4,6 @@ def get_docstring(obj):
		return ds.strip()
		else:
		return ""

		def get_summary(obj):
		return get_docstring(obj).partition("\n")[0].strip()
		No newline at end of file