102 lines
3.9 KiB
Ruby
102 lines
3.9 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module API
|
|
class ProjectPackages < ::API::Base
|
|
include PaginationParams
|
|
|
|
before do
|
|
authorize_packages_access!(user_project)
|
|
end
|
|
|
|
feature_category :package_registry
|
|
urgency :low
|
|
|
|
helpers ::API::Helpers::PackagesHelpers
|
|
|
|
params do
|
|
requires :id, types: [String, Integer], desc: 'The ID or URL-encoded path of the project'
|
|
end
|
|
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
|
desc 'Get a list of project packages' do
|
|
detail 'This feature was introduced in GitLab 11.8'
|
|
success code: 200, model: ::API::Entities::Package
|
|
failure [
|
|
{ code: 403, message: 'Forbidden' },
|
|
{ code: 404, message: 'Project Not Found' }
|
|
]
|
|
is_array true
|
|
tags %w[project_packages]
|
|
end
|
|
params do
|
|
use :pagination
|
|
optional :order_by, type: String, values: %w[created_at name version type], default: 'created_at',
|
|
desc: 'Return packages ordered by `created_at`, `name`, `version` or `type` fields.'
|
|
optional :sort, type: String, values: %w[asc desc], default: 'asc',
|
|
desc: 'Return packages sorted in `asc` or `desc` order.'
|
|
optional :package_type, type: String, values: Packages::Package.package_types.keys,
|
|
desc: 'Return packages of a certain type'
|
|
optional :package_name, type: String,
|
|
desc: 'Return packages with this name'
|
|
optional :include_versionless, type: Boolean,
|
|
desc: 'Returns packages without a version'
|
|
optional :status, type: String, values: Packages::Package.statuses.keys,
|
|
desc: 'Return packages with specified status'
|
|
end
|
|
route_setting :authentication, job_token_allowed: true
|
|
get ':id/packages' do
|
|
packages = ::Packages::PackagesFinder.new(
|
|
user_project,
|
|
declared_params.slice(:order_by, :sort, :package_type, :package_name, :include_versionless, :status)
|
|
).execute
|
|
|
|
present paginate(packages), with: ::API::Entities::Package, user: current_user, namespace: user_project.namespace
|
|
end
|
|
|
|
desc 'Get a single project package' do
|
|
detail 'This feature was introduced in GitLab 11.9'
|
|
success code: 200, model: ::API::Entities::Package
|
|
failure [
|
|
{ code: 403, message: 'Forbidden' },
|
|
{ code: 404, message: 'Not Found' }
|
|
]
|
|
tags %w[project_packages]
|
|
end
|
|
params do
|
|
requires :package_id, type: Integer, desc: 'The ID of a package'
|
|
end
|
|
route_setting :authentication, job_token_allowed: true
|
|
get ':id/packages/:package_id' do
|
|
package = ::Packages::PackageFinder
|
|
.new(user_project, params[:package_id]).execute
|
|
|
|
render_api_error!('Package not found', 404) unless package.default?
|
|
|
|
present package, with: ::API::Entities::Package, user: current_user, namespace: user_project.namespace
|
|
end
|
|
|
|
desc 'Delete a project package' do
|
|
detail 'This feature was introduced in GitLab 11.9'
|
|
success code: 204
|
|
failure [
|
|
{ code: 403, message: 'Forbidden' },
|
|
{ code: 404, message: 'Not Found' }
|
|
]
|
|
tags %w[project_packages]
|
|
end
|
|
params do
|
|
requires :package_id, type: Integer, desc: 'The ID of a package'
|
|
end
|
|
route_setting :authentication, job_token_allowed: true
|
|
delete ':id/packages/:package_id' do
|
|
authorize_destroy_package!(user_project)
|
|
|
|
package = ::Packages::PackageFinder
|
|
.new(user_project, params[:package_id]).execute
|
|
|
|
destroy_conditionally!(package) do |package|
|
|
::Packages::MarkPackageForDestructionService.new(container: package, current_user: current_user).execute
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|