Project

General

Profile

Actions

Bug #20986

closed

user_id parameter in ssh key create action is wrongly documented

Added by Tomáš Strachota about 7 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Normal
Category:
Users, Roles and Permissions
Target version:
Difficulty:
trivial
Triaged:
Fixed in Releases:
Found in Releases:

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

Related issues 2 (0 open2 closed)

Related to Hammer CLI - Bug #20476: Creating SSH Key in User Template functionality missing in hammer CLIClosed08/01/2017Actions
Related to Foreman - Bug #21299: documentation of user_id in ssh_keys API controller is wrongClosedMartin BacovskyActions
Actions

Also available in: Atom PDF