openstack/oslo.policy
Code Issues Proposed changes

Doc: declare YAML/JSON support

Browse Source 
oslo.policy can support both of YAML and JSON until now,
but some docstring and config option's help text are inconsistent.
This commit fixes them.

Change-Id: I23cc60c84be97a3aec158f81ac21ac0ba3779abd
This commit is contained in:
ChangBo Guo(gcb) 2016-09-22 17:07:18 +08:00
parent 3cd4d430f7
commit 9b4d7d063f
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
oslo_policy/opts.py
View File

@ -27,7 +27,7 @@ _option_group = 'oslo_policy'
_options = [ _options = [
cfg.StrOpt('policy_file', cfg.StrOpt('policy_file',
default='policy.json', default='policy.json',
help=_('The JSON file that defines policies.'), help=_('The file that defines policies.'),
deprecated_group='DEFAULT'), deprecated_group='DEFAULT'),
cfg.StrOpt('policy_default_rule', cfg.StrOpt('policy_default_rule',
default='default', default='default',
@ -84,7 +84,7 @@ def set_defaults(conf, policy_file=None):
:param conf: Configuration object, managed by the caller. :param conf: Configuration object, managed by the caller.
:type conf: oslo.config.cfg.ConfigOpts :type conf: oslo.config.cfg.ConfigOpts
:param policy_file: The base filename for the JSON file that :param policy_file: The base filename for the file that
defines policies. defines policies.
:type policy_file: unicode :type policy_file: unicode
""" """

2
oslo_policy/policy.py
View File

@ -584,7 +584,7 @@ class Enforcer(object):
LOG.debug('Reloaded policy file: %(path)s', {'path': path}) LOG.debug('Reloaded policy file: %(path)s', {'path': path})
def _get_policy_path(self, path): def _get_policy_path(self, path):
"""Locate the policy JSON data file/path. """Locate the policy YAML/JSON data file/path.
:param path: It's value can be a full path or related path. When :param path: It's value can be a full path or related path. When
full path specified, this function just returns the full full path specified, this function just returns the full