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

Started tidying web API docs

Browse source
This commit is contained in:
Joel Collins 2019-11-22 16:55:40 +00:00
parent c76e3e0ed3
commit 671b356e22
4 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/api.rst
View file

@ -5,6 +5,7 @@ Summary
------- -------
.. qrefflask:: openflexure_microscope.api.app:app .. qrefflask:: openflexure_microscope.api.app:app
:undoc-endpoints: index :undoc-endpoints: index
:blueprints: v2_root_blueprint, v2_streams_blueprint, v2_captures_blueprint, v2_settings_blueprint, v2_status_blueprint, v2_plugin_blueprint, v2_tasks_blueprint, v2_actions_blueprint
:undoc-static: :undoc-static:
:endpoints: :endpoints:
@ -12,6 +13,7 @@ Details
------- -------
.. autoflask:: openflexure_microscope.api.app:app .. autoflask:: openflexure_microscope.api.app:app
:undoc-endpoints: index :undoc-endpoints: index
:blueprints: v2_root_blueprint, v2_streams_blueprint, v2_captures_blueprint, v2_settings_blueprint, v2_status_blueprint, v2_plugin_blueprint, v2_tasks_blueprint, v2_actions_blueprint
:undoc-static: :undoc-static:
:endpoints: :endpoints:
:order: path :order: path

2
openflexure_microscope/api/v2/blueprints/actions/stage.py
View file

@ -16,7 +16,7 @@ class MoveStageAPI(MicroscopeView):
""" """
Set x, y and z positions of the stage. Set x, y and z positions of the stage.
.. :quickref: Position; Update current position .. :quickref: Actions; Move stage
:reqheader Accept: application/json :reqheader Accept: application/json
:<json boolean absolute: (true) move to absolute position, (false) move by relative amount :<json boolean absolute: (true) move to absolute position, (false) move by relative amount

2
openflexure_microscope/api/v2/blueprints/settings.py
View file

@ -78,7 +78,7 @@ class SettingsAPI(MicroscopeView):
""" """
Modify microscope configuration Modify microscope configuration
.. :quickref: Config; Set microscope config .. :quickref: Settings; Update microscope settings
**Example request**: **Example request**:

4
openflexure_microscope/api/v2/blueprints/streams.py
View file

@ -27,7 +27,7 @@ class MjpegAPI(MicroscopeView):
""" """
Real-time MJPEG stream from the microscope camera Real-time MJPEG stream from the microscope camera
.. :quickref: Stream; Camera MJPEG stream .. :quickref: Streams; Camera MJPEG stream
:>header Accept: image/jpeg :>header Accept: image/jpeg
:>header Content-Type: image/jpeg :>header Content-Type: image/jpeg
@ -51,7 +51,7 @@ class SnapshotAPI(MicroscopeView):
""" """
Single snapshot from the camera stream Single snapshot from the camera stream
.. :quickref: Stream; Camera snapshot .. :quickref: Streams; Camera snapshot
:>header Accept: image/jpeg :>header Accept: image/jpeg
:>header Content-Type: image/jpeg :>header Content-Type: image/jpeg