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>
2024-11-17 08:19:36 +00:00
parent 9e87184fbf
commit 2e4ff714f6
2 changed files with 9 additions and 0 deletions
@@ -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
 --------------