[openstack-dev] [keystone][doc][tempest] What title should be for OS-KSCRUD extension

Ken'ichi Ohmichi ken1ohmichi at gmail.com
Wed Dec 9 02:56:45 UTC 2015

Hi Keystone-team,

  Keystone v2 API supports PATCH on '/OS-KSCRUD/users/{user_id}',
  What should we name the operation for?

We are adding the api-site link to Tempest docstring for explaining
how to use each REST APIs of each project.
This work comes from previous discussion on openstack-dev[1].
We can find problems on Tempest and the api-site and solve them, that
is good thing for improving the quality.
During this work[2], we are facing a problem difficult to distinguish
what title is the best for OS-KSCRUD extension on Keystone v2 API.

Keystone v2 API provides an API on "OS-KSCRUD/users/<user-id>" with PATCH.
That seems "Update user" from REST design, but according to the
following Keystone implementation, that seems "Set user password".

131         mapper.connect('/OS-KSCRUD/users/{user_id}',
132                        controller=user_controller,
133                        action='set_user_password',   <HERE>
134                        conditions=dict(method=['PATCH']))

Which is the best for this API?

The api-site doesn't contain this API description[3], so it will be
great to get feedback for improving both the api-site and Tempest.

Ken Ohmichi

[1]: http://lists.openstack.org/pipermail/openstack-dev/2015-July/068864.html
[2]: https://review.openstack.org/#/c/253806/
[3]: https://bugs.launchpad.net/openstack-api-site/+bug/1524153

More information about the OpenStack-dev mailing list