summaryrefslogtreecommitdiff
path: root/lib/api/runners.rb
blob: 44aae2220c5666a6b216517cad86920b35cdbcc3 (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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
module API
  # Runners API
  class Runners < Grape::API
    resource :runners do
      # Get list of all available runners
      #
      # Example Request:
      #   GET /runners
      get do
        authenticate!
        runners = Runner.all

        present runners, with: Entities::Runner
      end

      # Delete runner
      # Parameters:
      #   token (required) - The unique token of runner
      #
      # Example Request:
      #   GET /runners/delete
      delete "delete" do
        required_attributes! [:token]
        authenticate_runner!
        Runner.find_by_token(params[:token]).destroy
      end

      # Register a new runner
      #
      # Note: This is an "internal" API called when setting up
      # runners, so it is authenticated differently.
      #
      # Parameters:
      #   token (required) - The unique token of runner
      #
      # Example Request:
      #   POST /runners/register
      post "register" do
        required_attributes! [:token]

        runner =
          if params[:token] == GitlabCi::REGISTRATION_TOKEN
            # Create shared runner. Requires admin access
            Runner.create(
              description: params[:description],
              tag_list: params[:tag_list],
              is_shared: true
            )
          elsif project = Project.find_by(token: params[:token])
            # Create a specific runner for project.
            project.runners.create(
              description: params[:description],
              tag_list: params[:tag_list]
            )
          end

        return forbidden! unless runner

        if runner.id
          present runner, with: Entities::Runner
        else
          not_found!
        end
      end
    end
  end
end