Commit 671b356e authored by Joel Collins's avatar Joel Collins
Browse files

Started tidying web API docs

parent c76e3e0e

docs/source/api.rst

+2 −0
Original line number Diff line number Diff line
@@ -5,6 +5,7 @@ Summary 
-------

.. qrefflask:: openflexure_microscope.api.app:app

   :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:

   :endpoints:
@@ -12,6 +13,7 @@ Details 
-------

.. autoflask:: openflexure_microscope.api.app:app

   :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:

   :endpoints:

   :order: path

openflexure_microscope/api/v2/blueprints/actions/stage.py

+1 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ class MoveStageAPI(MicroscopeView): 
        """

        Set x, y and z positions of the stage.



        .. :quickref: Position; Update current position

        .. :quickref: Actions; Move stage



        :reqheader Accept: application/json

        :<json boolean absolute: (true) move to absolute position, (false) move by relative amount

openflexure_microscope/api/v2/blueprints/settings.py

+1 −1
Original line number Diff line number Diff line
@@ -78,7 +78,7 @@ class SettingsAPI(MicroscopeView): 
        """

        Modify microscope configuration



        .. :quickref: Config; Set microscope config

        .. :quickref: Settings; Update microscope settings



        **Example request**:

openflexure_microscope/api/v2/blueprints/streams.py

+2 −2
Original line number Diff line number Diff line
@@ -27,7 +27,7 @@ class MjpegAPI(MicroscopeView): 
        """

        Real-time MJPEG stream from the microscope camera



        .. :quickref: Stream; Camera MJPEG stream

        .. :quickref: Streams; Camera MJPEG stream



        :>header Accept: image/jpeg

        :>header Content-Type: image/jpeg
@@ -51,7 +51,7 @@ class SnapshotAPI(MicroscopeView): 
        """

        Single snapshot from the camera stream



        .. :quickref: Stream; Camera snapshot

        .. :quickref: Streams; Camera snapshot



        :>header Accept: image/jpeg

        :>header Content-Type: image/jpeg