Skip to content

Commit

Permalink
fix docstring typo
Browse files Browse the repository at this point in the history
  • Loading branch information
paulineribeyre committed Jun 3, 2021
1 parent 8ee70a5 commit 33d4774
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions fence/resources/audit/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,13 +77,14 @@ def enable_audit_logging(f):
This decorator should be added to any API endpoint for which we
record audit logs. It should not be added to non-audited endpoints,
so that performance is not impacted.
The audit decorator is only added if auditing is enabled, so that
performance is not impacted when auditing is disabled.
The `create_audit_log_for_request_decorator` decorator is only added
if auditing is enabled, so that performance is not impacted when auditing
is disabled.
Possible improvement: pass a "category" argument to `is_audit_enabled`.
/!\ This decorator is not enough to enable audit logging for an endpoint.
Logic must be added to `create_audit_log_for_request()` and the audit
service might needed to be updated to handle new types of data.
service might need to be updated to handle new types of data.
"""

@wraps(f)
Expand Down

0 comments on commit 33d4774

Please sign in to comment.