Adjust docstring for Action class in light of the new Action.ACCESS value

Viewing (i.e. accessing) objects *may* now be logged.

And higher numerical value no longer means more intrusive action, since access has the highest value and is the least intrusive.
This commit is contained in:
Gabriel Niebler 2026-04-17 17:26:09 +02:00 committed by GitHub
parent 7e33d8261e
commit 9b890b07e1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -318,10 +318,7 @@ class AbstractLogEntry(models.Model):
class Action:
"""
The actions that Auditlog distinguishes: creating, updating and deleting objects. Viewing objects
is not logged. The values of the actions are numeric, a higher integer value means a more intrusive
action. This may be useful in some cases when comparing actions because the ``__lt``, ``__lte``,
``__gt``, ``__gte`` lookup filters can be used in queries.
The actions that Auditlog distinguishes: creating, updating, deleting and accessing objects.
The valid actions are :py:attr:`Action.CREATE`, :py:attr:`Action.UPDATE`,
:py:attr:`Action.DELETE` and :py:attr:`Action.ACCESS`.