1 files changed, 10 insertions, 2 deletions
diff --git a/lib/api/keys.rb b/lib/api/keys.rb
index fb1bedd5e92..77952bac01a 100644
--- a/lib/api/keys.rb
+++ b/lib/api/keys.rb
@@ -9,8 +9,13 @@ module API
 
     resource :keys do
       desc 'Get single ssh key by id. Only available to admin users' do
+        detail 'Get SSH key with user by ID of an SSH key. Note only administrators can lookup SSH key with user by ID\
+        of an SSH key'
         success Entities::SSHKeyWithUser
       end
+      params do
+        requires :id, types: [String, Integer], desc: 'The ID of an SSH key', documentation: { example: '2' }
+      end
       get ":id" do
         authenticated_as_admin!
 
@@ -19,11 +24,14 @@ module API
         present key, with: Entities::SSHKeyWithUser, current_user: current_user
       end
 
-      desc 'Get SSH Key information' do
+      desc 'Get user by fingerprint of SSH key' do
         success Entities::UserWithAdmin
+        detail 'You can search for a user that owns a specific SSH key. Note only administrators can lookup SSH key\
+        with the fingerprint of an SSH key'
       end
       params do
-        requires :fingerprint, type: String, desc: 'Search for a SSH fingerprint'
+        requires :fingerprint, type: String, desc: 'The fingerprint of an SSH key',
+                               documentation: { example: 'ba:81:59:68:d7:6c:cd:02:02:bf:6a:9b:55:4e:af:d1' }
       end
       get do
         authenticated_with_can_read_all_resources!