openstack/python-keystoneclient
Code Issues Proposed changes

Reference docstring for auth_token fields

Browse Source 
The documented variables that the auth_token middleware sets for
the request was out of date with the code. Rather than maintain
the documentation for the fields in 2 places we'll now link to the
auth_token module docs.

Change-Id: Id4ca1843f749c1ed0b515c8860764add3ec4a3da
This commit is contained in:
Brant Knudson
2014-02-02 11:29:45 -06:00
committed by Gerrit Code Review
parent b63bd9c3d8
commit b24351f912
1 changed files with 4 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
doc/source/middlewarearchitecture.rst
View File

@@ -315,41 +315,12 @@ Extended the request with additional User Information
----------------------------------------------------- -----------------------------------------------------
:py:class:`keystoneclient.middleware.auth_token.AuthProtocol` extends the :py:class:`keystoneclient.middleware.auth_token.AuthProtocol` extends the
request with additional information if the user has been authenticated. request with additional information if the user has been authenticated. See the
"What we add to the request for use by the OpenStack service" section in
:py:mod:`keystoneclient.middleware.auth_token` for the list of fields set by
the auth_token middleware.
X-Identity-Status
Provides information on whether the request was authenticated or not.
X-Tenant-Id
The unique, immutable tenant Id
X-Tenant-Name
The unique, but mutable (it can change) tenant name.
X-User-Id
The user id of the user used to log in
X-User-Name
The username used to log in
X-Roles
The roles associated with that user
Deprecated additions
--------------------
X-Tenant
Provides the tenant name. This is to support any legacy implementations
before Keystone switched to an ID/Name schema for tenants.
X-User
The username used to log in. This is to support any legacy implementations
before Keystone switched to an ID/Name schema for tenants.
X-Role
The roles associated with that user
References References
========== ==========