132 lines
4.2 KiB
Ruby
132 lines
4.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module API
|
|
class GroupExport < ::API::Base
|
|
before do
|
|
authorize! :admin_group, user_group
|
|
end
|
|
|
|
feature_category :importers
|
|
urgency :low
|
|
|
|
params do
|
|
requires :id, type: String, desc: 'The ID of a group'
|
|
end
|
|
resource :groups, requirements: { id: %r{[^/]+} } do
|
|
desc 'Download export' do
|
|
detail 'This feature was introduced in GitLab 12.5.'
|
|
tags %w[group_export]
|
|
produces %w[application/octet-stream application/json]
|
|
success code: 200
|
|
failure [
|
|
{ code: 400, message: 'Bad request' },
|
|
{ code: 401, message: 'Unauthorized' },
|
|
{ code: 403, message: 'Forbidden' },
|
|
{ code: 404, message: 'Not found' },
|
|
{ code: 503, message: 'Service unavailable' }
|
|
]
|
|
end
|
|
get ':id/export/download' do
|
|
check_rate_limit! :group_download_export, scope: [current_user, user_group]
|
|
|
|
if user_group.export_file_exists?
|
|
if user_group.export_archive_exists?
|
|
present_carrierwave_file!(user_group.export_file)
|
|
else
|
|
render_api_error!('The group export file is not available yet', 404)
|
|
end
|
|
else
|
|
render_api_error!('404 Not found or has expired', 404)
|
|
end
|
|
end
|
|
|
|
desc 'Start export' do
|
|
detail 'This feature was introduced in GitLab 12.5.'
|
|
tags %w[group_export]
|
|
success code: 202
|
|
failure [
|
|
{ code: 401, message: 'Unauthorized' },
|
|
{ code: 403, message: 'Forbidden' },
|
|
{ code: 404, message: 'Not found' },
|
|
{ code: 429, message: 'Too many requests' },
|
|
{ code: 503, message: 'Service unavailable' }
|
|
]
|
|
end
|
|
post ':id/export' do
|
|
check_rate_limit! :group_export, scope: current_user
|
|
|
|
export_service = ::Groups::ImportExport::ExportService.new(group: user_group, user: current_user)
|
|
|
|
if export_service.async_execute
|
|
accepted!
|
|
else
|
|
render_api_error!(message: 'Group export could not be started.')
|
|
end
|
|
end
|
|
|
|
desc 'Start relations export' do
|
|
detail 'This feature was introduced in GitLab 13.12'
|
|
tags %w[group_export]
|
|
success code: 202
|
|
failure [
|
|
{ code: 401, message: 'Unauthorized' },
|
|
{ code: 403, message: 'Forbidden' },
|
|
{ code: 404, message: 'Not found' },
|
|
{ code: 503, message: 'Service unavailable' }
|
|
]
|
|
end
|
|
post ':id/export_relations' do
|
|
response = ::BulkImports::ExportService.new(portable: user_group, user: current_user).execute
|
|
|
|
if response.success?
|
|
accepted!
|
|
else
|
|
render_api_error!(message: 'Group relations export could not be started.')
|
|
end
|
|
end
|
|
|
|
desc 'Download relations export' do
|
|
detail 'This feature was introduced in GitLab 13.12'
|
|
produces %w[application/octet-stream application/json]
|
|
tags %w[group_export]
|
|
success code: 200
|
|
failure [
|
|
{ code: 401, message: 'Unauthorized' },
|
|
{ code: 403, message: 'Forbidden' },
|
|
{ code: 404, message: 'Not found' },
|
|
{ code: 503, message: 'Service unavailable' }
|
|
]
|
|
end
|
|
params do
|
|
requires :relation, type: String, desc: 'Group relation name'
|
|
end
|
|
get ':id/export_relations/download' do
|
|
export = user_group.bulk_import_exports.find_by_relation(params[:relation])
|
|
file = export&.upload&.export_file
|
|
|
|
if file
|
|
present_carrierwave_file!(file)
|
|
else
|
|
render_api_error!('404 Not found', 404)
|
|
end
|
|
end
|
|
|
|
desc 'Relations export status' do
|
|
detail 'This feature was introduced in GitLab 13.12'
|
|
is_array true
|
|
tags %w[group_export]
|
|
success code: 200, model: Entities::BulkImports::ExportStatus
|
|
failure [
|
|
{ code: 401, message: 'Unauthorized' },
|
|
{ code: 403, message: 'Forbidden' },
|
|
{ code: 404, message: 'Not found' },
|
|
{ code: 503, message: 'Service unavailable' }
|
|
]
|
|
end
|
|
get ':id/export_relations/status' do
|
|
present user_group.bulk_import_exports, with: Entities::BulkImports::ExportStatus
|
|
end
|
|
end
|
|
end
|
|
end
|