Actions
Bug #21299
closed
documentation of user_id in ssh_keys API controller is wrong
Status:
Closed
Priority:
Normal
Assignee:
Category:
Users, Roles and Permissions
Target version:
Description
In API v2 ssh_keys_controller in :index and :show method the 'user_id' parameter is documented as not required.
https://github.com/theforeman/foreman/blob/develop/app/controllers/api/v2/ssh_keys_controller.rb#L12
https://github.com/theforeman/foreman/blob/develop/app/controllers/api/v2/ssh_keys_controller.rb#L21
param :user_id, String, :desc => N_("ID of the user")
It is part of the resource URL and needs to be required. Wrong documentation leads to problems with parameter resolving in Hammer CLI.
hammer user ssh-keys delete --user admin --name test Could not delete the SSH Key: missing param 'user_id' in parameters
Updated by Martin Bacovsky about 7 years ago
- Subject changed from documentation of user_id in ssh_keys controller is wrong to documentation of user_id in ssh_keys API controller is wrong
Updated by Martin Bacovsky about 7 years ago
- Status changed from New to Assigned
- Assignee set to Martin Bacovsky
- Target version set to 226
- Difficulty set to easy
Updated by Marek Hulán about 7 years ago
- Related to Bug #20986: user_id parameter in ssh key create action is wrongly documented added
Updated by Martin Bacovsky about 7 years ago
- Project changed from Hammer CLI to Foreman
- Category changed from Users and roles to 218
Updated by The Foreman Bot about 7 years ago
- Status changed from Assigned to Ready For Testing
- Pull request https://github.com/theforeman/foreman/pull/4907 added
Updated by Timo Goebel about 7 years ago
- Translation missing: en.field_release set to 240
Updated by Martin Bacovsky about 7 years ago
- Status changed from Ready For Testing to Closed
- % Done changed from 0 to 100
Applied in changeset 5cb587b6990ceb5f368e493f772c6748bd07f9c8.
Updated by Tomer Brisker over 4 years ago
- Category changed from 218 to Users, Roles and Permissions
Actions