1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
# frozen_string_literal: true
module API
# Environments RESTfull API endpoints
class Environments < Grape::API
include ::API::Helpers::CustomValidators
include PaginationParams
before { authenticate! }
params do
requires :id, type: String, desc: "The project ID"
end
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
desc "Get all environments of the project" do
detail "This feature was introduced in GitLab 8.11."
success Entities::Environment
end
params do
use :pagination
end
get ":id/environments" do
authorize! :read_environment, user_project
present paginate(user_project.environments), with: Entities::Environment
end
desc "Creates a new environment" do
detail "This feature was introduced in GitLab 8.11."
success Entities::Environment
end
params do
requires :name, type: String, desc: "The name of the environment to be created"
optional :external_url, type: String, desc: "URL on which this deployment is viewable"
optional :slug, absence: {message: "is automatically generated and cannot be changed"}
end
post ":id/environments" do
authorize! :create_environment, user_project
environment = user_project.environments.create(declared_params)
if environment.persisted?
present environment, with: Entities::Environment
else
render_validation_error!(environment)
end
end
desc "Updates an existing environment" do
detail "This feature was introduced in GitLab 8.11."
success Entities::Environment
end
params do
requires :environment_id, type: Integer, desc: "The environment ID"
optional :name, type: String, desc: "The new environment name"
optional :external_url, type: String, desc: "The new URL on which this deployment is viewable"
optional :slug, absence: {message: "is automatically generated and cannot be changed"}
end
put ":id/environments/:environment_id" do
authorize! :update_environment, user_project
environment = user_project.environments.find(params[:environment_id])
update_params = declared_params(include_missing: false).extract!(:name, :external_url)
if environment.update(update_params)
present environment, with: Entities::Environment
else
render_validation_error!(environment)
end
end
desc "Deletes an existing environment" do
detail "This feature was introduced in GitLab 8.11."
success Entities::Environment
end
params do
requires :environment_id, type: Integer, desc: "The environment ID"
end
delete ":id/environments/:environment_id" do
authorize! :update_environment, user_project
environment = user_project.environments.find(params[:environment_id])
destroy_conditionally!(environment)
end
desc "Stops an existing environment" do
success Entities::Environment
end
params do
requires :environment_id, type: Integer, desc: "The environment ID"
end
post ":id/environments/:environment_id/stop" do
authorize! :read_environment, user_project
environment = user_project.environments.find(params[:environment_id])
authorize! :stop_environment, environment
environment.stop_with_action!(current_user)
status 200
present environment, with: Entities::Environment
end
end
end
end
|
