Merge pull request StackStorm#4495 from StackStorm/inquiry_exp

Move inquiries API path from /exp to /v1

CHANGELOG.rst

@@ -18,6 +18,11 @@ Added
    For backward compatibility reasons, if pack metadata file doesn't contain that attribute, it's
    assumed it only works with Python 2. (new feature) #4474
 
+Changed
+~~~~~~~
+
+* Changed the ``inquiries`` API path from ``/exp`` to ``/api/v1`` #4495
+
 2.10.0 - December 13, 2018
 --------------------------
 

st2api/tests/base.py

@@ -256,17 +256,17 @@ def _do_get_execution(self, actionexecution_id, *args, **kwargs):
         return self.app.get('/v1/executions/%s' % actionexecution_id, *args, **kwargs)
 
     def _do_get_one(self, inquiry_id, *args, **kwargs):
-        return self.app.get('/exp/inquiries/%s' % inquiry_id, *args, **kwargs)
+        return self.app.get('/v1/inquiries/%s' % inquiry_id, *args, **kwargs)
 
     def _do_get_all(self, limit=50, *args, **kwargs):
-        return self.app.get('/exp/inquiries/?limit=%s' % limit, *args, **kwargs)
+        return self.app.get('/v1/inquiries/?limit=%s' % limit, *args, **kwargs)
 
     def _do_respond(self, inquiry_id, response, *args, **kwargs):
         payload = {
             "id": inquiry_id,
             "response": response
         }
-        return self.app.put_json('/exp/inquiries/%s' % inquiry_id, payload, *args, **kwargs)
+        return self.app.put_json('/v1/inquiries/%s' % inquiry_id, payload, *args, **kwargs)
 
     def _do_create_inquiry(self, liveaction, result, status='pending', *args, **kwargs):
         post_resp = self.app.post_json('/v1/executions', liveaction, *args, **kwargs)

st2api/tests/unit/controllers/exp/test_inquiries.py → st2api/tests/unit/controllers/v1/test_inquiries.py

@@ -22,7 +22,7 @@
 from six.moves import http_client
 
 from st2common.transport.publishers import PoolPublisher
-from st2api.controllers.exp.inquiries import InquiriesController
+from st2api.controllers.v1.inquiries import InquiriesController
 from st2common.constants import action as action_constants
 from st2common import log as logging
 import st2common.validators.api.action as action_validator
@@ -166,7 +166,7 @@
 @mock.patch.object(PoolPublisher, 'publish', mock.MagicMock())
 class InquiryControllerTestCase(BaseInquiryControllerTestCase,
                                 APIControllerWithIncludeAndExcludeFilterTestCase):
-    get_all_path = '/exp/inquiries'
+    get_all_path = '/v1/inquiries'
     controller_cls = InquiriesController
     include_attribute_field_name = 'ttl'
     exclude_attribute_field_name = 'ttl'

st2api/tests/unit/controllers/exp/test_inquiries_rbac.py → st2api/tests/unit/controllers/v1/test_inquiries_rbac.py

@@ -29,7 +29,7 @@
 from st2tests import fixturesloader
 
 from tests import base as api_tests_base
-from tests.unit.controllers.exp import test_inquiries
+from tests.unit.controllers.v1 import test_inquiries
 
 
 SCHEMA_DEFAULT = copy.deepcopy(test_inquiries.SCHEMA_DEFAULT)

st2client/st2client/client.py

@@ -136,7 +136,7 @@ def __init__(self, base_url=None, auth_url=None, api_url=None, stream_url=None,
         # backward compatibility reasons until v3.2.0
         self.managers['LiveAction'] = self.managers['Execution']
         self.managers['Inquiry'] = InquiryResourceManager(
-            models.Inquiry, self.endpoints['exp'], cacert=self.cacert, debug=self.debug)
+            models.Inquiry, self.endpoints['api'], cacert=self.cacert, debug=self.debug)
         self.managers['Pack'] = PackResourceManager(
             models.Pack, self.endpoints['api'], cacert=self.cacert, debug=self.debug)
         self.managers['Policy'] = ResourceManager(

st2common/st2common/openapi.yaml

@@ -1361,9 +1361,9 @@ paths:
           description: Unexpected error
           schema:
             $ref: '#/definitions/Error'
-  /api/exp/inquiries:
+  /api/v1/inquiries:
     get:
-      operationId: st2api.controllers.exp.inquiries:inquiries_controller.get_all
+      operationId: st2api.controllers.v1.inquiries:inquiries_controller.get_all
       x-permissions: inquiry_list
       description: Returns a list of all inquiries
       parameters:
@@ -1401,9 +1401,9 @@ paths:
           description: Unexpected error
           schema:
             $ref: '#/definitions/Error'
-  /api/exp/inquiries/{inquiry_id}:
+  /api/v1/inquiries/{inquiry_id}:
     get:
-      operationId: st2api.controllers.exp.inquiries:inquiries_controller.get_one
+      operationId: st2api.controllers.v1.inquiries:inquiries_controller.get_one
       description: |
         Get a specific Inquiry based on ID.
       parameters:
@@ -1427,7 +1427,7 @@ paths:
           schema:
             $ref: '#/definitions/Error'
     put:
-      operationId: st2api.controllers.exp.inquiries:inquiries_controller.put
+      operationId: st2api.controllers.v1.inquiries:inquiries_controller.put
       description: |
         Respond to an Inquiry.
       parameters:

st2common/st2common/openapi.yaml.j2

@@ -1357,9 +1357,9 @@ paths:
           description: Unexpected error
           schema:
             $ref: '#/definitions/Error'
-  /api/exp/inquiries:
+  /api/v1/inquiries:
     get:
-      operationId: st2api.controllers.exp.inquiries:inquiries_controller.get_all
+      operationId: st2api.controllers.v1.inquiries:inquiries_controller.get_all
       x-permissions: {{ PERMISSION_TYPE.INQUIRY_LIST }}
       description: Returns a list of all inquiries
       parameters:
@@ -1397,9 +1397,9 @@ paths:
           description: Unexpected error
           schema:
             $ref: '#/definitions/Error'
-  /api/exp/inquiries/{inquiry_id}:
+  /api/v1/inquiries/{inquiry_id}:
     get:
-      operationId: st2api.controllers.exp.inquiries:inquiries_controller.get_one
+      operationId: st2api.controllers.v1.inquiries:inquiries_controller.get_one
       description: |
         Get a specific Inquiry based on ID.
       parameters:
@@ -1423,7 +1423,7 @@ paths:
           schema:
             $ref: '#/definitions/Error'
     put:
-      operationId: st2api.controllers.exp.inquiries:inquiries_controller.put
+      operationId: st2api.controllers.v1.inquiries:inquiries_controller.put
       description: |
         Respond to an Inquiry.
       parameters: