2018-09-29 22:34:47 +00:00
# frozen_string_literal: true
2016-08-16 06:45:23 +00:00
module API
2017-03-06 17:19:15 +00:00
# Deployments RESTful API endpoints
2020-10-15 00:08:42 +00:00
class Deployments < :: API :: Base
2016-11-21 19:15:46 +00:00
include PaginationParams
2016-08-16 06:45:23 +00:00
before { authenticate! }
2020-10-29 12:08:50 +00:00
feature_category :continuous_delivery
2016-08-16 06:45:23 +00:00
params do
requires :id , type : String , desc : 'The project ID'
end
2018-11-08 12:18:17 +00:00
resource :projects , requirements : API :: NAMESPACE_OR_PROJECT_REQUIREMENTS do
2016-08-16 06:45:23 +00:00
desc 'Get all deployments of the project' do
detail 'This feature was introduced in GitLab 8.11.'
success Entities :: Deployment
end
params do
2016-11-21 19:15:46 +00:00
use :pagination
2019-11-28 03:06:32 +00:00
optional :order_by , type : String , values : DeploymentsFinder :: ALLOWED_SORT_VALUES , default : DeploymentsFinder :: DEFAULT_SORT_VALUE , desc : 'Return deployments ordered by specified value'
optional :sort , type : String , values : DeploymentsFinder :: ALLOWED_SORT_DIRECTIONS , default : DeploymentsFinder :: DEFAULT_SORT_DIRECTION , desc : 'Sort by asc (ascending) or desc (descending)'
optional :updated_after , type : DateTime , desc : 'Return deployments updated after the specified date'
optional :updated_before , type : DateTime , desc : 'Return deployments updated before the specified date'
2020-01-17 21:08:29 +00:00
optional :environment ,
type : String ,
desc : 'The name of the environment to filter deployments by'
optional :status ,
type : String ,
values : Deployment . statuses . keys ,
desc : 'The status to filter deployments by'
2016-08-16 06:45:23 +00:00
end
2019-11-28 03:06:32 +00:00
2016-08-16 06:45:23 +00:00
get ':id/deployments' do
authorize! :read_deployment , user_project
2021-03-29 12:09:14 +00:00
deployments =
DeploymentsFinder . new ( params . merge ( project : user_project ) )
. execute . with_api_entity_associations
2019-11-28 03:06:32 +00:00
present paginate ( deployments ) , with : Entities :: Deployment
2021-05-06 06:10:11 +00:00
rescue DeploymentsFinder :: InefficientQueryError = > e
bad_request! ( e . message )
2016-08-16 06:45:23 +00:00
end
desc 'Gets a specific deployment' do
detail 'This feature was introduced in GitLab 8.11.'
2022-02-02 06:16:52 +00:00
success Entities :: DeploymentExtended
2016-08-16 06:45:23 +00:00
end
params do
2019-01-16 12:09:29 +00:00
requires :deployment_id , type : Integer , desc : 'The deployment ID'
2016-08-16 06:45:23 +00:00
end
get ':id/deployments/:deployment_id' do
authorize! :read_deployment , user_project
deployment = user_project . deployments . find ( params [ :deployment_id ] )
2022-02-02 06:16:52 +00:00
present deployment , with : Entities :: DeploymentExtended
2016-08-16 06:45:23 +00:00
end
2019-10-16 18:08:01 +00:00
desc 'Creates a new deployment' do
detail 'This feature was introduced in GitLab 12.4'
2022-02-02 06:16:52 +00:00
success Entities :: DeploymentExtended
2019-10-16 18:08:01 +00:00
end
params do
requires :environment ,
type : String ,
desc : 'The name of the environment to deploy to'
requires :sha ,
type : String ,
desc : 'The SHA of the commit that was deployed'
requires :ref ,
type : String ,
desc : 'The name of the branch or tag that was deployed'
requires :tag ,
type : Boolean ,
desc : 'A boolean indicating if the deployment ran for a tag'
requires :status ,
type : String ,
desc : 'The status of the deployment' ,
values : %w[ running success failed canceled ]
end
post ':id/deployments' do
authorize! ( :create_deployment , user_project )
authorize! ( :create_environment , user_project )
environment = user_project
. environments
. find_or_create_by_name ( params [ :environment ] )
unless environment . persisted?
render_validation_error! ( deployment )
end
authorize! ( :create_deployment , environment )
service = :: Deployments :: CreateService
. new ( environment , current_user , declared_params )
deployment = service . execute
if deployment . persisted?
2022-02-02 06:16:52 +00:00
present ( deployment , with : Entities :: DeploymentExtended , current_user : current_user )
2019-10-16 18:08:01 +00:00
else
render_validation_error! ( deployment )
end
end
desc 'Updates an existing deployment' do
detail 'This feature was introduced in GitLab 12.4'
2022-02-02 06:16:52 +00:00
success Entities :: DeploymentExtended
2019-10-16 18:08:01 +00:00
end
params do
requires :status ,
type : String ,
desc : 'The new status of the deployment' ,
values : %w[ running success failed canceled ]
end
put ':id/deployments/:deployment_id' do
authorize! ( :read_deployment , user_project )
deployment = user_project . deployments . find ( params [ :deployment_id ] )
authorize! ( :update_deployment , deployment )
if deployment . deployable
forbidden! ( 'Deployments created using GitLab CI can not be updated using the API' )
end
service = :: Deployments :: UpdateService . new ( deployment , declared_params )
if service . execute
2022-02-02 06:16:52 +00:00
present ( deployment , with : Entities :: DeploymentExtended , current_user : current_user )
2019-10-16 18:08:01 +00:00
else
render_validation_error! ( deployment )
end
end
2020-01-13 21:07:39 +00:00
helpers Helpers :: MergeRequestsHelpers
desc 'Get all merge requests of a deployment' do
detail 'This feature was introduced in GitLab 12.7.'
success Entities :: MergeRequestBasic
end
params do
2020-02-25 00:09:12 +00:00
use :pagination
2020-01-13 21:07:39 +00:00
requires :deployment_id , type : Integer , desc : 'The deployment ID'
use :merge_requests_base_params
end
get ':id/deployments/:deployment_id/merge_requests' do
authorize! :read_deployment , user_project
mr_params = declared_params . merge ( deployment_id : params [ :deployment_id ] )
merge_requests = MergeRequestsFinder . new ( current_user , mr_params ) . execute
2020-02-25 00:09:12 +00:00
present paginate ( merge_requests ) , { with : Entities :: MergeRequestBasic , current_user : current_user }
2020-01-13 21:07:39 +00:00
end
2016-08-16 06:45:23 +00:00
end
end
end
2022-01-06 06:10:35 +00:00
API :: Deployments . prepend_mod