keystonemiddleware/releasenotes/notes/rename-auth-uri-d223d883f5898aee.yaml
Colleen Murphy 409b482253 Rename auth_uri to www_authenticate_uri
The [keystone_authtoken]/auth_uri middleware parameter has been causing
extreme confusion amongst operators and developers ever since the
keystonemiddleware started accepting keystoneauth plugin parameters
including auth_url. The two parameters look identical and yet have
completely different meanings and are both required. This patch
deprecates auth_uri and renames it to www_authenticate_uri, which more
accurately describes the WWW-Authenticate header it is configuring and
is dissimilar to any other keystone_authtoken middleware parameter. This
also renames the internal variable names for consistency with the config
option.

Change-Id: I0cf11da3d395749df28077427689fdafc8a6b981
2017-10-11 14:00:49 +02:00

10 lines
430 B
YAML

---
deprecations:
- |
The auth_uri parameter of keystone_authtoken is deprecated in favor of
www_authenticate_uri. The auth_uri option was often confused with the
auth_url parameter of the keystoneauth plugin, which was also effectively
always required. The parameter refers to the WWW-Authenticate header that is
returned when the user needs to be redirected to the Identity service for
authentication.