Added a description field using docstrings
This commit is contained in:
parent
eb321220c6
commit
c2d27e8f56
2 changed files with 9 additions and 1 deletions
|
|
@ -28,13 +28,15 @@ def plugins_representation(plugin_loader_object: PluginLoader):
|
||||||
"plugin": str(plugin),
|
"plugin": str(plugin),
|
||||||
"views": {},
|
"views": {},
|
||||||
"form": plugin.form,
|
"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}")
|
logging.debug(f"Representing view {view_id}")
|
||||||
uri = url_for(f"v2_plugins_blueprint.{view_id}")
|
uri = url_for(f"v2_plugins_blueprint.{view_id}")
|
||||||
# Make links dictionary if it doesn't yet exist
|
# Make links dictionary if it doesn't yet exist
|
||||||
view_d = {
|
view_d = {
|
||||||
|
"description": view_data["view"].__doc__.strip() if view_data["view"].__doc__ else "",
|
||||||
"links": {"self": uri}
|
"links": {"self": uri}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -18,6 +18,9 @@ class MeasureSharpnessAPI(MicroscopeViewPlugin):
|
||||||
|
|
||||||
|
|
||||||
class AutofocusAPI(MicroscopeViewPlugin):
|
class AutofocusAPI(MicroscopeViewPlugin):
|
||||||
|
"""
|
||||||
|
Run a standard autofocus
|
||||||
|
"""
|
||||||
def post(self):
|
def post(self):
|
||||||
payload = JsonResponse(request)
|
payload = JsonResponse(request)
|
||||||
|
|
||||||
|
|
@ -36,6 +39,9 @@ class AutofocusAPI(MicroscopeViewPlugin):
|
||||||
|
|
||||||
|
|
||||||
class FastAutofocusAPI(MicroscopeViewPlugin):
|
class FastAutofocusAPI(MicroscopeViewPlugin):
|
||||||
|
"""
|
||||||
|
Run a fast autofocus
|
||||||
|
"""
|
||||||
def post(self):
|
def post(self):
|
||||||
payload = JsonResponse(request)
|
payload = JsonResponse(request)
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue