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

Get default description and summary from docstring

Browse source
This commit is contained in:
jtc42 2020-01-02 22:43:24 +00:00
parent b0316ae494
commit 3bcfd86ccc
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
openflexure_microscope/common/flask_labthings/spec.py
View file

@ -4,6 +4,8 @@ from .utilities import rupdate
from apispec import APISpec from apispec import APISpec
from apispec.ext.marshmallow import MarshmallowPlugin from apispec.ext.marshmallow import MarshmallowPlugin
from openflexure_microscope.common.labthings_core.utilities import get_docstring
from .fields import Field from .fields import Field
from marshmallow import Schema as BaseSchema from marshmallow import Schema as BaseSchema
@ -13,6 +15,8 @@ def view2path(rule: str, view: Resource, spec: APISpec):
params = { params = {
"path": rule, # TODO: Validate this slightly (leading / etc) "path": rule, # TODO: Validate this slightly (leading / etc)
"operations": view2operations(view, spec), "operations": view2operations(view, spec),
"description": get_docstring(view),
"summary": get_docstring(view).partition("\n")[0].strip()
} }
if hasattr(view, "__apispec__"): if hasattr(view, "__apispec__"):