From d406b03354408c8141a4bfcd15e5d50fed487974 Mon Sep 17 00:00:00 2001 From: Joel Collins Date: Wed, 15 Jul 2020 16:03:14 +0100 Subject: [PATCH] Fixed swagger-ui links --- docs/source/api.rst | 2 +- docs/source/extensions/views.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/api.rst b/docs/source/api.rst index bbdc8d3f..4fd4b616 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -4,6 +4,6 @@ HTTP API 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/swagger-ui``. +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``. .. note:: We should have an online copy of the API SwaggerUI documentation up soon. \ No newline at end of file diff --git a/docs/source/extensions/views.rst b/docs/source/extensions/views.rst index a27ec4b2..be8364fb 100644 --- a/docs/source/extensions/views.rst +++ b/docs/source/extensions/views.rst @@ -29,6 +29,6 @@ When a POST request is made to our API view, the server converts the body of the Swagger documentation +++++++++++++++++++++ -At this point, it is useful to introduce the automatically generated Swagger documentation. From any web browser, go to ``http://microscope.local/api/v2/swagger-ui`` (or replace ``microscope.local`` with your microscope's IP address if ``microscope.local`` doesn't work for your system). +At this point, it is useful to introduce the automatically generated Swagger documentation. From any web browser, go to ``http://microscope.local/api/v2/docs/swagger-ui`` (or replace ``microscope.local`` with your microscope's IP address if ``microscope.local`` doesn't work for your system). This page uses `SwaggerUI `_ to provide visual, interactive API documentation. Find your extensions URL in the documentation under the ``extensions`` group. Basic documentation about the parameters required for your POST method should be visible, as well as an interactive example filled out with the example request given in the view ``schema``.