Change endpoint to api/tools/<tool_id>/dependencies

A POST will trigger installation and DELETE will trigger uninstalling the dependencies (Thx for the suggestion @jmchilton).
galaxyproject · Mar 12, 2017 · d5b5d29 · d5b5d29
1 parent 3b067ef
commit d5b5d29
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/lib/galaxy/webapps/galaxy/api/tools.py b/lib/galaxy/webapps/galaxy/api/tools.py
@@ -135,7 +135,11 @@ def requirements(self, trans, id, **kwds):
     @web.require_admin
     def install_dependencies(self, trans, id, **kwds):
         """
-        POST /api/tools/{tool_id}/install_dependencies
+        POST /api/tools/{tool_id}/dependencies
+
+        This endpoint is also available through POST /api/tools/{tool_id}/install_dependencies,
+        but will be deprecated in the future.
+
         Attempts to install requirements via the dependency resolver
 
         parameters:
@@ -154,7 +158,7 @@ def install_dependencies(self, trans, id, **kwds):
     @web.require_admin
     def uninstall_dependencies(self, trans, id, **kwds):
         """
-        POST /api/tools/{tool_id}/uninstall_dependencies
+        DELETE /api/tools/{tool_id}/dependencies
         Attempts to uninstall requirements via the dependency resolver
 
         """

diff --git a/lib/galaxy/webapps/galaxy/buildapp.py b/lib/galaxy/webapps/galaxy/buildapp.py
@@ -269,7 +269,8 @@ def populate_api_routes( webapp, app ):
     webapp.mapper.connect( '/api/tools/{id:.+?}/download', action='download', controller="tools" )
     webapp.mapper.connect( '/api/tools/{id:.+?}/requirements', action='requirements', controller="tools")
     webapp.mapper.connect( '/api/tools/{id:.+?}/install_dependencies', action='install_dependencies', controller="tools", conditions=dict( method=[ "POST" ] ))
-    webapp.mapper.connect( '/api/tools/{id:.+?}/uninstall_dependencies', action='uninstall_dependencies', controller="tools", conditions=dict( method=[ "POST" ] ))
+    webapp.mapper.connect( '/api/tools/{id:.+?}/dependencies', action='install_dependencies', controller="tools", conditions=dict( method=[ "POST" ] ))
+    webapp.mapper.connect( '/api/tools/{id:.+?}/dependencies', action='uninstall_dependencies', controller="tools", conditions=dict( method=[ "DELETE" ] ))
     webapp.mapper.connect( '/api/tools/{id:.+?}/build_dependency_cache', action='build_dependency_cache', controller="tools", conditions=dict( method=[ "POST" ] ))
     webapp.mapper.connect( '/api/tools/{id:.+?}', action='show', controller="tools" )
     webapp.mapper.resource( 'tool', 'tools', path_prefix='/api' )

diff --git a/test/integration/test_resolvers.py b/test/integration/test_resolvers.py
@@ -120,14 +120,14 @@ def test_conda_install_through_tools_api( self ):
 
     def test_uninstall_through_tools_api(self):
         tool_id = 'mulled_example_multi_1'
-        endpoint = "tools/%s/install_dependencies" % tool_id
+        endpoint = "tools/%s/dependencies" % tool_id
         data = {'id': tool_id}
         create_response = self._post(endpoint, data=data, admin=True)
         self._assert_status_code_is( create_response, 200 )
         response = create_response.json()
         assert any([True for d in response if d['dependency_type'] == 'conda'])
-        endpoint = "tools/%s/uninstall_dependencies" % tool_id
-        create_response = self._post(endpoint, data=data, admin=True)
+        endpoint = "tools/%s/dependencies" % tool_id
+        create_response = self._delete(endpoint, data=data, admin=True)
         self._assert_status_code_is(create_response, 200)
         response = create_response.json()
         assert not [True for d in response if d['dependency_type'] == 'conda']