Skip to content

Commit

Permalink
docs(history): add section on middleware for user tracking
Browse files Browse the repository at this point in the history
  • Loading branch information
sennierer committed Dec 10, 2024
1 parent 320e73f commit 9fb4551
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/source/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,25 @@ The :py:mod:`apis_core.history` module provides versioning
for APIS. It is based on the `django-simple-history`_
package.

Track changes by users
^^^^^^^^^^^^^^^^^^^^^^

To record the user who made a change, the `django-simple-history` module
used by APIS provides a middleware that sets the `history_user` attribute of
the request object to the current user. It then saves this information to the
`history_user` attribute of the historical record.
To activate the middleware, add `simple_history.middleware.HistoryRequestMiddleware`
to your `MIDDLEWARE` setting:

.. code-block:: python
MIDDLEWARE = [
...
'apis_core.history.middleware.HistoryRequestMiddleware',
...
]
VersionMixin
^^^^^^^^^^^^

Expand Down
1 change: 1 addition & 0 deletions sample_project/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
"django.contrib.messages.middleware.MessageMiddleware",
"django.middleware.clickjacking.XFrameOptionsMiddleware",
"crum.CurrentRequestUserMiddleware",
"simple_history.middleware.HistoryRequestMiddleware",
]

# ROOT_URLCONF = "apis_core.urls"
Expand Down

0 comments on commit 9fb4551

Please sign in to comment.