Actions
Bug #20986
closeduser_id parameter in ssh key create action is wrongly documented
Status:
Closed
Priority:
Normal
Assignee:
Category:
Users, Roles and Permissions
Target version:
Difficulty:
trivial
Triaged:
Pull request:
Description
The API docs for
POST /api/users/:user_id/ssh_keys
document the :user_id parameter as nested in ssh_key hash but the server expect it on the first level as it's a route parameter. This causes issues in hammer that uses the documentation to automatically build the request data.
The current documetation:
Param name Validations Description ssh_key Hash ssh_key[name] String ssh_key[key] String Public SSH key ssh_key[user_id] String ID of the user
Expected result:
The :user_id parameter should be documented on the first level, outside of the ssh_key hash:
Param name Validations Description user_id String ID of the user ssh_key Hash ssh_key[name] String ssh_key[key] String Public SSH key
Actions