summaryrefslogtreecommitdiff
path: root/lib/api/group_boards.rb
blob: 0479b877e3556d835aeb6e6025a53c6e061a307d (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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# frozen_string_literal: true

module API
  class GroupBoards < Grape::API
    include BoardsResponses
    include PaginationParams

    before do
      authenticate!
    end

    helpers do
      def board_parent
        user_group
      end
    end

    params do
      requires :id, type: String, desc: "The ID of a group"
    end

    resource :groups, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
      segment ":id/boards" do
        desc "Find a group board" do
          detail "This feature was introduced in 10.6"
          success ::API::Entities::Board
        end
        get "/:board_id" do
          present board, with: ::API::Entities::Board
        end

        desc "Get all group boards" do
          detail "This feature was introduced in 10.6"
          success Entities::Board
        end
        params do
          use :pagination
        end
        get "/" do
          present paginate(board_parent.boards), with: Entities::Board
        end
      end

      params do
        requires :board_id, type: Integer, desc: "The ID of a board"
      end
      segment ":id/boards/:board_id" do
        desc "Get the lists of a group board" do
          detail "Does not include backlog and closed lists. This feature was introduced in 10.6"
          success Entities::List
        end
        params do
          use :pagination
        end
        get "/lists" do
          present paginate(board_lists), with: Entities::List
        end

        desc "Get a list of a group board" do
          detail "This feature was introduced in 10.6"
          success Entities::List
        end
        params do
          requires :list_id, type: Integer, desc: "The ID of a list"
        end
        get "/lists/:list_id" do
          present board_lists.find(params[:list_id]), with: Entities::List
        end

        desc "Create a new board list" do
          detail "This feature was introduced in 10.6"
          success Entities::List
        end
        params do
          use :list_creation_params
        end
        post "/lists" do
          authorize_list_type_resource!

          authorize!(:admin_list, user_group)

          create_list
        end

        desc "Moves a board list to a new position" do
          detail "This feature was introduced in 10.6"
          success Entities::List
        end
        params do
          requires :list_id,  type: Integer, desc: "The ID of a list"
          requires :position, type: Integer, desc: "The position of the list"
        end
        put "/lists/:list_id" do
          list = board_lists.find(params[:list_id])

          authorize!(:admin_list, user_group)

          move_list(list)
        end

        desc "Delete a board list" do
          detail "This feature was introduced in 10.6"
          success Entities::List
        end
        params do
          requires :list_id, type: Integer, desc: "The ID of a board list"
        end
        delete "/lists/:list_id" do
          authorize!(:admin_list, user_group)
          list = board_lists.find(params[:list_id])

          destroy_list(list)
        end
      end
    end
  end
end