summaryrefslogtreecommitdiffstats
path: root/keystone
diff options
context:
space:
mode:
authorJoe Heck <heckj@mac.com>2012-11-10 15:57:59 -0800
committerJoe Heck <heckj@mac.com>2012-11-10 15:57:59 -0800
commitc74009025f097a6a8743cc4e20a70dd29a6e558d (patch)
treec0b9b0377ec47955aec211d2fed601e63606847a /keystone
parent126dd9c9bdab46074d812f4a16358357d364e789 (diff)
downloadkeystone-c74009025f097a6a8743cc4e20a70dd29a6e558d.tar.gz
keystone-c74009025f097a6a8743cc4e20a70dd29a6e558d.tar.xz
keystone-c74009025f097a6a8743cc4e20a70dd29a6e558d.zip
tweaking docs to fix link to wiki Keystone page
updated docstrings to remove two errors reformatted front page header to be consistent added links to autogenerated python documentation Change-Id: I59fddc12ff458bbd0102a40d4d85903ab6bd6394
Diffstat (limited to 'keystone')
-rw-r--r--keystone/common/bufferedhttp.py2
-rw-r--r--keystone/policy/backends/rules.py16
-rw-r--r--keystone/token/core.py7
3 files changed, 14 insertions, 11 deletions
diff --git a/keystone/common/bufferedhttp.py b/keystone/common/bufferedhttp.py
index 8738caca..7461dc27 100644
--- a/keystone/common/bufferedhttp.py
+++ b/keystone/common/bufferedhttp.py
@@ -129,6 +129,7 @@ def http_connect(ipaddr, port, device, partition, method, path,
:param key_file Private key file (not needed if cert_file has private key)
:param cert_file Certificate file (Keystore)
:returns: HTTPConnection object
+
"""
path = quote('/' + device + '/' + str(partition) + path)
return http_connect_raw(ipaddr, port, device, partition, method, path,
@@ -153,6 +154,7 @@ def http_connect_raw(ipaddr, port, method, path, headers=None,
:param key_file Private key file (not needed if cert_file has private key)
:param cert_file Certificate file (Keystore)
:returns: HTTPConnection object
+
"""
if ssl:
conn = HTTPSConnection('%s:%s' % (ipaddr, port), key_file=key_file,
diff --git a/keystone/policy/backends/rules.py b/keystone/policy/backends/rules.py
index 92a90efa..c0df430e 100644
--- a/keystone/policy/backends/rules.py
+++ b/keystone/policy/backends/rules.py
@@ -79,20 +79,20 @@ def enforce(credentials, action, target):
"""Verifies that the action is valid on the target in this context.
:param credentials: user credentials
- :param action: string representing the action to be checked
-
- this should be colon separated for clarity.
- i.e. compute:create_instance
- compute:attach_volume
- volume:attach_volume
-
+ :param action: string representing the action to be checked, which
+ should be colon separated for clarity.
:param target: dictionary representing the object of the action
for object creation this should be a dictionary
representing the location of the object e.g.
{'tenant_id': object.tenant_id}
-
:raises: `exception.Forbidden` if verification fails.
+ Actions should be colon separated for clarity. For example:
+
+ * compute:create_instance
+ * compute:attach_volume
+ * volume:attach_volume
+
"""
init()
diff --git a/keystone/token/core.py b/keystone/token/core.py
index 56ef13fe..05994538 100644
--- a/keystone/token/core.py
+++ b/keystone/token/core.py
@@ -56,9 +56,10 @@ class Driver(object):
def token_to_key(self, token_id):
""" Converts PKI tokens to their short form used for keys in
Database tables, memcached, and other lookup tables.
- returns: if given a PKI token, returns its hashed value
- Otherwise, returns the passed-in value if given a UUID or
- hash of a token.
+
+ :returns: if given a PKI token, returns its hashed value
+ Otherwise, returns the passed-in value if given a UUID or
+ hash of a token.
"""
return cms.cms_hash_token(token_id)