debian-mirror-gitlab/lib/api/boards.rb

117 lines
3.2 KiB
Ruby
Raw Normal View History

2016-11-03 12:29:30 +05:30
module API
class Boards < Grape::API
2018-03-17 18:26:18 +05:30
include BoardsResponses
2017-08-17 22:00:37 +05:30
include PaginationParams
2016-11-03 12:29:30 +05:30
before { authenticate! }
2018-03-17 18:26:18 +05:30
helpers do
def board_parent
user_project
end
end
2016-11-03 12:29:30 +05:30
params do
requires :id, type: String, desc: 'The ID of a project'
end
2018-03-17 18:26:18 +05:30
resource :projects, requirements: API::PROJECT_ENDPOINT_REQUIREMENTS do
segment ':id/boards' do
desc 'Get all project boards' do
detail 'This feature was introduced in 8.13'
success Entities::Board
end
params do
use :pagination
end
get '/' do
authorize!(:read_board, user_project)
present paginate(board_parent.boards), with: Entities::Board
end
desc 'Find a project board' do
detail 'This feature was introduced in 10.4'
success Entities::Board
end
get '/:board_id' do
2018-11-08 19:23:39 +05:30
authorize!(:read_board, user_project)
2018-03-17 18:26:18 +05:30
present board, with: Entities::Board
end
2016-11-03 12:29:30 +05:30
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 project board' do
2017-08-17 22:00:37 +05:30
detail 'Does not include `done` list. This feature was introduced in 8.13'
2016-11-03 12:29:30 +05:30
success Entities::List
end
2017-08-17 22:00:37 +05:30
params do
use :pagination
end
2016-11-03 12:29:30 +05:30
get '/lists' do
authorize!(:read_board, user_project)
2017-08-17 22:00:37 +05:30
present paginate(board_lists), with: Entities::List
2016-11-03 12:29:30 +05:30
end
desc 'Get a list of a project board' do
detail 'This feature was introduced in 8.13'
success Entities::List
end
params do
requires :list_id, type: Integer, desc: 'The ID of a list'
end
get '/lists/:list_id' do
authorize!(:read_board, user_project)
present board_lists.find(params[:list_id]), with: Entities::List
end
desc 'Create a new board list' do
detail 'This feature was introduced in 8.13'
success Entities::List
end
params do
2018-11-18 11:00:15 +05:30
use :list_creation_params
2016-11-03 12:29:30 +05:30
end
post '/lists' do
2018-11-18 11:00:15 +05:30
authorize_list_type_resource!
2016-11-03 12:29:30 +05:30
authorize!(:admin_list, user_project)
2018-03-17 18:26:18 +05:30
create_list
2016-11-03 12:29:30 +05:30
end
desc 'Moves a board list to a new position' do
detail 'This feature was introduced in 8.13'
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
2018-03-17 18:26:18 +05:30
list = board_lists.find(params[:list_id])
2016-11-03 12:29:30 +05:30
authorize!(:admin_list, user_project)
2018-03-17 18:26:18 +05:30
move_list(list)
2016-11-03 12:29:30 +05:30
end
desc 'Delete a board list' do
detail 'This feature was introduced in 8.13'
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_project)
list = board_lists.find(params[:list_id])
2018-03-17 18:26:18 +05:30
destroy_list(list)
2016-11-03 12:29:30 +05:30
end
end
end
end
end