Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ms/1095 history user not recorded in history objects #1096

Merged
merged 1 commit into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading