Improved documentation about admin api (#1846)

* - added note about admin api routes * - fixed openapi path * - open api -> OpenAPI, admin api -> admin API --------- Co-authored-by: doublebyte1 <info@doublebyte.net>
geopython · Nov 17, 2024 · 2e4ff71 · 2e4ff71
1 parent 9e87184
commit 2e4ff71
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/source/_static/openapi_admin.png b/docs/source/_static/openapi_admin.png
diff --git a/docs/source/admin-api.rst b/docs/source/admin-api.rst
@@ -14,6 +14,15 @@ The API is enabled with the following server configuration:
     server:
         admin: true # boolean on whether to enable Admin API.
 
+.. note::
+
+    If you generate the OpenAPI definition after enabling the admin API, the admin routes will be exposed on ``/openapi`` 
+
+    .. image:: /_static/openapi_admin.png
+        :alt: admin routes
+        :align: center
+
+
 Access control
 --------------