summaryrefslogtreecommitdiff
path: root/lib/api/keys.rb
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2022-11-17 11:33:21 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2022-11-17 11:33:21 +0000
commit7021455bd1ed7b125c55eb1b33c5a01f2bc55ee0 (patch)
tree5bdc2229f5198d516781f8d24eace62fc7e589e9 /lib/api/keys.rb
parent185b095e93520f96e9cfc31d9c3e69b498cdab7c (diff)
downloadgitlab-ce-7021455bd1ed7b125c55eb1b33c5a01f2bc55ee0.tar.gz
Add latest changes from gitlab-org/gitlab@15-6-stable-eev15.6.0-rc42
Diffstat (limited to 'lib/api/keys.rb')
-rw-r--r--lib/api/keys.rb12
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!