openstack
/
oslo.policy
Code Issues Proposed changes

expand type documentation for Enforcer arguments 

As part of bug #1720354 we discovered that arguments being passed to
the enforcer were not always dictionaries and did not always support
the full API needed. Expand the documentation to make the requirements
clearer.

Change-Id: I6c940d825cf72777e2a7946ab7489a1ed5359235
Closes-Bug: #1720354
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-10-09 09:31:08 -04:00
parent cb35d34802
commit 8710f6338d
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
oslo_policy/policy.py
View File

@ -706,8 +706,12 @@ class Enforcer(object):
:param rule: The rule to evaluate.
:type rule: string or :class:`BaseCheck`
:param dict target: As much information about the object being operated
on as possible.
:param dict target: As much information about the object being
operated on as possible. The target
argument should be a dict instance or an
instance of a class that fully supports
the Mapping abstract base class and deep
copying.
:param dict creds: As much information about the user performing the
action as possible.
:param do_raise: Whether to raise an exception or not if check