summaryrefslogtreecommitdiff
path: root/lib/api/environments.rb
diff options
context:
space:
mode:
authorZ.J. van de Weg <zegerjan@gitlab.com>2016-07-26 09:37:02 +0200
committerZ.J. van de Weg <zegerjan@gitlab.com>2016-07-29 13:54:45 +0200
commit84cd2120952e7ee4095cb4b5d7c959f2c11610c5 (patch)
tree3f4f3498543311c4291f88285778c9d71c9cc21e /lib/api/environments.rb
parentbe9aa7f19474424991923f128053e2523fa166d8 (diff)
downloadgitlab-ce-84cd2120952e7ee4095cb4b5d7c959f2c11610c5.tar.gz
Add API support for environments
Diffstat (limited to 'lib/api/environments.rb')
-rw-r--r--lib/api/environments.rb87
1 files changed, 87 insertions, 0 deletions
diff --git a/lib/api/environments.rb b/lib/api/environments.rb
new file mode 100644
index 00000000000..66a047f72fc
--- /dev/null
+++ b/lib/api/environments.rb
@@ -0,0 +1,87 @@
+module API
+ # Environments RESTfull API endpoints
+ class Environments < Grape::API
+ before { authenticate! }
+
+ resource :projects do
+ # Get all labels of the project
+ #
+ # Parameters:
+ # id (required) - The ID of a project
+ # Example Request:
+ # GET /projects/:id/environments
+ get ':id/environments' do
+ authorize! :read_environment, user_project
+
+ present paginate(user_project.environments), with: Entities::Environment
+ end
+
+ # Creates a new environment
+ #
+ # Parameters:
+ # id (required) - The ID of a project
+ # name (required) - The name of the environment to be created
+ # external_url (optional) - URL on which this deployment is viewable
+ #
+ # Example Request:
+ # POST /projects/:id/labels
+ post ':id/environments' do
+ authorize! :create_environment, user_project
+ required_attributes! [:name]
+
+ attrs = attributes_for_keys [:name, :external_url]
+ environment = user_project.environments.find_by(name: attrs[:name])
+
+ conflict!('Environment already exists') if environment
+
+ environment = user_project.environments.create(attrs)
+
+ if environment.valid?
+ present environment, with: Entities::Environment
+ else
+ render_validation_error!(environment)
+ end
+ end
+
+ # Deletes an existing environment
+ #
+ # Parameters:
+ # id (required) - The ID of a project
+ # environment_id (required) - The name of the environment to be deleted
+ #
+ # Example Request:
+ # DELETE /projects/:id/environments/:environment_id
+ delete ':id/environments/:environment_id' do
+ authorize! :admin_environment, user_project
+
+ environment = user_project.environments.find(params[:environment_id])
+
+ present environment.destroy, with: Entities::Environment
+ end
+
+ # Updates an existing environment
+ #
+ # Parameters:
+ # id (required) - The ID of a project
+ # environment_id (required) - The ID of the environment
+ # name (optional) - The name of the label to be deleted
+ # external_url (optional) - The new name of the label
+ #
+ # Example Request:
+ # PUT /projects/:id/environments/:environment_id
+ put ':id/environments/:environment_id' do
+ authorize! :update_environment, user_project
+
+ environment = user_project.environments.find(params[:environment_id])
+
+ attrs = attributes_for_keys [:name, :external_url]
+
+ if environment.update(attrs)
+ present environment, with: Entities::Environment
+ else
+ render_validation_error!(environment)
+ end
+ end
+ end
+ end
+end