summaryrefslogtreecommitdiff
path: root/lib/api/keys.rb
blob: 4c302727c4fb3ec9c52a5f38b127af82918c80b4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
module Gitlab
  # Keys API
  class Keys < Grape::API
    before { authenticate! }
    resource :keys do
      # Get currently authenticated user's keys
      #
      # Example Request:
      #   GET /keys
      get do
        present current_user.keys, with: Entities::Key
      end
      # Get single key owned by currently authenticated user
      #
      # Example Request:
      #   GET /keys/:id
      get "/:id" do
        key = current_user.keys.find params[:id]
        present key, with: Entities::Key
      end
      # Add new ssh key to currently authenticated user
      # 
      # Parameters:
      #   key (required) - New SSH Key
      #   title (required) - New SSH Key's title
      # Example Request:
      #   POST /keys
      post do
        attrs = attributes_for_keys [:title, :key]
        key = current_user.keys.new attrs
        if key.save
          present key, with: Entities::Key
        else
          not_found!
        end
      end
      # Delete existed ssh key of currently authenticated user
      # 
      # Parameters:
      #   id (required) - SSH Key ID
      # Example Request:
      #   DELETE /keys/:id
      delete "/:id" do
        key = current_user.keys.find params[:id]
        key.delete
      end
    end
  end
end