diff --git a/docs/source/_static/openapi_admin.png b/docs/source/_static/openapi_admin.png new file mode 100644 index 000000000..8fd9af443 Binary files /dev/null and b/docs/source/_static/openapi_admin.png differ diff --git a/docs/source/admin-api.rst b/docs/source/admin-api.rst index 346df0a91..19ce12b9a 100644 --- 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 --------------