Skip to content

Commit 2e4ff71

Browse files
doublebyte1doublebyte1
and
doublebyte1
authored
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 <[email protected]>
1 parent 9e87184 commit 2e4ff71

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

docs/source/_static/openapi_admin.png

208 KB
Loading

docs/source/admin-api.rst

+9
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ The API is enabled with the following server configuration:
1414
server:
1515
admin: true # boolean on whether to enable Admin API.
1616
17+
.. note::
18+
19+
If you generate the OpenAPI definition after enabling the admin API, the admin routes will be exposed on ``/openapi``
20+
21+
.. image:: /_static/openapi_admin.png
22+
:alt: admin routes
23+
:align: center
24+
25+
1726
Access control
1827
--------------
1928

0 commit comments

Comments
 (0)