Added a description field using docstrings (c2d27e8f) · Commits · OpenFlexure / openflexure-microscope-server

openflexure_microscope/api/v2/blueprints/plugins.py

+3 −1

Original line number	Diff line number	Diff line
		@@ -28,13 +28,15 @@ def plugins_representation(plugin_loader_object: PluginLoader):
		"plugin": str(plugin),
		"views": {},
		"form": plugin.form,
		"description": plugin.__doc__.strip() if plugin.__doc__ else ""
		}

		for view_id, view in plugin.views.items():
		for view_id, view_data in plugin.views.items():
		logging.debug(f"Representing view {view_id}")
		uri = url_for(f"v2_plugins_blueprint.{view_id}")
		# Make links dictionary if it doesn't yet exist
		view_d = {
		"description": view_data["view"].__doc__.strip() if view_data["view"].__doc__ else "",
		"links": {"self": uri}
		}

+6 −0

Original line number	Diff line number	Diff line
		@@ -18,6 +18,9 @@ class MeasureSharpnessAPI(MicroscopeViewPlugin):


		class AutofocusAPI(MicroscopeViewPlugin):
		"""
		Run a standard autofocus
		"""
		def post(self):
		payload = JsonResponse(request)

		@@ -36,6 +39,9 @@ class AutofocusAPI(MicroscopeViewPlugin):


		class FastAutofocusAPI(MicroscopeViewPlugin):
		"""
		Run a fast autofocus
		"""
		def post(self):
		payload = JsonResponse(request)