gitlab-org--gitlab-foss/lib/api/ci/resource_groups.rb

87 lines
2.7 KiB
Ruby

# frozen_string_literal: true
module API
module Ci
class ResourceGroups < ::API::Base
include PaginationParams
before { authenticate! }
feature_category :continuous_delivery
urgency :low
params do
requires :id, types: [String, Integer], desc: 'The ID or URL-encoded path of the project'
end
resource :projects, requirements: ::API::API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
desc 'Get all resource groups for this project' do
success Entities::Ci::ResourceGroup
end
params do
use :pagination
end
get ':id/resource_groups' do
authorize! :read_resource_group, user_project
present paginate(user_project.resource_groups), with: Entities::Ci::ResourceGroup
end
desc 'Get a single resource group' do
success Entities::Ci::ResourceGroup
end
params do
requires :key, type: String, desc: 'The key of the resource group'
end
get ':id/resource_groups/:key' do
authorize! :read_resource_group, resource_group
present resource_group, with: Entities::Ci::ResourceGroup
end
desc 'List upcoming jobs of a resource group' do
success Entities::Ci::JobBasic
end
params do
requires :key, type: String, desc: 'The key of the resource group'
use :pagination
end
get ':id/resource_groups/:key/upcoming_jobs' do
authorize! :read_resource_group, resource_group
authorize! :read_build, user_project
upcoming_processables = resource_group
.upcoming_processables
.preload(:user, pipeline: :project) # rubocop:disable CodeReuse/ActiveRecord
present paginate(upcoming_processables), with: Entities::Ci::JobBasic
end
desc 'Edit a resource group' do
success Entities::Ci::ResourceGroup
end
params do
requires :key, type: String, desc: 'The key of the resource group'
optional :process_mode, type: String, desc: 'The process mode',
values: ::Ci::ResourceGroup.process_modes.keys
end
put ':id/resource_groups/:key' do
authorize! :update_resource_group, resource_group
if resource_group.update(declared_params(include_missing: false))
present resource_group, with: Entities::Ci::ResourceGroup
else
render_validation_error!(resource_group)
end
end
end
helpers do
def resource_group
@resource_group ||= user_project.resource_groups.find_by_key!(params[:key])
end
end
end
end
end