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

Update link to openapi documentation

Browse source
This commit is contained in:
Richard 2021-09-21 15:41:29 +01:00
parent ebf8376bd4
commit f0fcd53487
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/source/api.rst
View file

@ -6,7 +6,7 @@ Live documentation
Full, interactive Swagger documentation for your microscopes web API is available from the microscope itself. From any browser, go to ``http://{your microscope IP address}/api/v2/docs/swagger-ui``.
The API is described in an OpenAPI description, available at ``http://{your microscope IP address}/api/v2/docs/openapi.yaml``. It is also available from our `build server`_. It can be conveniently viewed using Redoc, for example `link to test OpenAPI rendering`_
The API is described in an OpenAPI description, available at ``http://{your microscope IP address}/api/v2/docs/openapi.yaml``. It is also available from our `build server`_. It can be conveniently viewed using `Redoc's online preview`_.
.. _`build server`: https://build.openflexure.org/openflexure-microscope-server/
.. _`link to test OpenAPI rendering`: https://redocly.github.io/redoc/?url=https://build.openflexure.org/temp/rwb34/swagger.yaml
.. _`Redoc's online preview`: https://redocly.github.io/redoc/?url=https://build.openflexure.org/openflexure-microscope-server/latest-api.yaml