[docs] Minor improvements to REST API and settings

openwisp · Jun 4, 2024 · ca60194 · ca60194
1 parent 8415832
commit ca60194
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/docs/user/rest-api.rst b/docs/user/rest-api.rst
@@ -1,19 +1,23 @@
 REST API
 ========
 
-To enable the API the setting `OPENWISP_USERS_AUTH_API <#openwisp-users-auth-api>`_ must
-be set to ``True``.
+.. note::
+
+    The REST API is enabled by default but can be disabled by setting
+    :ref:`OPENWISP_USERS_AUTH_API` to ``False``.
 
 Live documentation
 ------------------
 
 A general live API documentation (following the OpenAPI specification) at
 ``/api/v1/docs/``.
 
-Browsable web interface
+Browsable Web Interface
 -----------------------
 
 .. image:: https://github.com/openwisp/openwisp-users/raw/docs/docs/images/api-ui.png
+    :target: https://github.com/openwisp/openwisp-users/raw/docs/docs/images/api-ui.png
+    :alt: Browsable REST API Web Interface
 
 Additionally, opening any of the endpoints listed below directly in the browser will
 show the `browsable API interface of Django-REST-Framework

diff --git a/docs/user/settings.rst b/docs/user/settings.rst
@@ -1,6 +1,8 @@
 Settings
 ========
 
+.. include:: /partials/settings-note.rst
+
 ``OPENWISP_ORGANIZATION_USER_ADMIN``
 ------------------------------------
 
@@ -25,6 +27,8 @@ or not.
 
 Find out more information about `organization owners <#organization-owners>`_.
 
+.. _openwisp_users_auth_api:
+
 ``OPENWISP_USERS_AUTH_API``
 ---------------------------
 
@@ -70,6 +74,8 @@ Each prefix will be prepended to the username string automatically and parsed wi
 This allows users to log in by using only the national phone number, without having to
 specify the international prefix.
 
+.. _openwisp_users_export_users_command_config:
+
 ``OPENWISP_USERS_EXPORT_USERS_COMMAND_CONFIG``
 ----------------------------------------------