From 2edd8e65310595018fa02e3f1e3cb8a69bf75bef Mon Sep 17 00:00:00 2001
From: Rick Bartra <rb560u@att.com>
Date: Thu, 23 Aug 2018 12:15:22 -0400
Subject: [PATCH] Update Shipyard API docs and shipyard_api_client

The Shipyard API docs and shipyard_api_client incorrectly reference
the wrong API endpoints for some APIs. This commit updates the API
docs to reference the correct API endpoints for:

- getting action validation details
- triggering a control action against an activity

The following is updated in the shipyard_api_client.py:

- API endpoint for getting action validation details

Change-Id: I04b770acfd64f331efce6f83f51cb41d0818a6b2
---
 docs/source/API.rst                                  | 12 ++++++------
 .../api_client/shipyard_api_client.py                |  2 +-
 .../unit/apiclient_test/test_shipyard_api_client.py  |  2 +-
 .../tests/unit/cli/describe/test_describe_actions.py |  4 ++--
 4 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/docs/source/API.rst b/docs/source/API.rst
index 0dc5ff30..9f789aa5 100644
--- a/docs/source/API.rst
+++ b/docs/source/API.rst
@@ -621,8 +621,8 @@ Example
       "action_lifecycle": "Failed"
     }
 
-/v1.0/actions/{action_id}/validationdetails/{validation_id}
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+/v1.0/actions/{action_id}/validations/{validation_id}
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Allows for drilldown to validation detailed info.
 
 Entity Structure
@@ -633,8 +633,8 @@ The detailed information for a validation
 
     { TBD }
 
-GET /v1.0/actions/{action_id}/validationdetails/{validation_id}
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+GET /v1.0/actions/{action_id}/validations/{validation_id}
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Returns the validation detail by Id for the supplied action Id.
 
 Responses
@@ -733,8 +733,8 @@ Entity Structure
 ^^^^^^^^^^^^^^^^
 None, there is no associated response entity for this resource
 
-POST /v1.0/actions/{action_id}/{control_verb}
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+POST /v1.0/actions/{action_id}/control/{control_verb}
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Trigger a control action against an activity.- this includes: pause, unpause
 
 Responses
diff --git a/src/bin/shipyard_client/shipyard_client/api_client/shipyard_api_client.py b/src/bin/shipyard_client/shipyard_client/api_client/shipyard_api_client.py
index 4eae8f04..5ff433dc 100644
--- a/src/bin/shipyard_client/shipyard_client/api_client/shipyard_api_client.py
+++ b/src/bin/shipyard_client/shipyard_client/api_client/shipyard_api_client.py
@@ -30,7 +30,7 @@ class ApiPaths(enum.Enum):
     COMMIT_CONFIG = _BASE_URL + 'commitconfigdocs'
     POST_GET_ACTIONS = _BASE_URL + 'actions'
     GET_ACTION_DETAIL = _BASE_URL + 'actions/{}'
-    GET_VALIDATION_DETAIL = _BASE_URL + 'actions/{}/validationdetails/{}'
+    GET_VALIDATION_DETAIL = _BASE_URL + 'actions/{}/validations/{}'
     GET_STEP_DETAIL = _BASE_URL + 'actions/{}/steps/{}'
     GET_STEP_LOG = _BASE_URL + 'actions/{}/steps/{}/logs'
     POST_CONTROL_ACTION = _BASE_URL + 'actions/{}/control/{}'
diff --git a/src/bin/shipyard_client/tests/unit/apiclient_test/test_shipyard_api_client.py b/src/bin/shipyard_client/tests/unit/apiclient_test/test_shipyard_api_client.py
index c8776b9a..3104c403 100644
--- a/src/bin/shipyard_client/tests/unit/apiclient_test/test_shipyard_api_client.py
+++ b/src/bin/shipyard_client/tests/unit/apiclient_test/test_shipyard_api_client.py
@@ -168,7 +168,7 @@ def test_get_val_details(*args):
     action_id = 'GoodAction'
     validation_id = 'Validation'
     result = shipyard_client.get_validation_detail(action_id, validation_id)
-    assert result['url'] == '{}/actions/{}/validationdetails/{}'.format(
+    assert result['url'] == '{}/actions/{}/validations/{}'.format(
         shipyard_client.get_endpoint(), action_id, validation_id)
 
 
diff --git a/src/bin/shipyard_client/tests/unit/cli/describe/test_describe_actions.py b/src/bin/shipyard_client/tests/unit/cli/describe/test_describe_actions.py
index 907938bd..913188e5 100644
--- a/src/bin/shipyard_client/tests/unit/cli/describe/test_describe_actions.py
+++ b/src/bin/shipyard_client/tests/unit/cli/describe/test_describe_actions.py
@@ -171,7 +171,7 @@ def test_describe_validation(*args):
     responses.add(
         responses.GET,
         'http://shiptest/actions/01BTTMFVDKZFRJM80FGD7J1AKN/'
-        'validationdetails/02AURNEWAAAESKN99EBF8J2BHD',
+        'validations/02AURNEWAAAESKN99EBF8J2BHD',
         body=GET_VALIDATION_API_RESP,
         status=200)
 
@@ -197,7 +197,7 @@ def test_describe_validation_not_found(*args):
     responses.add(
         responses.GET,
         'http://shiptest/actions/01BTTMFVDKZFRJM80FGD7J1AKN/'
-        'validationdetails/02AURNEWAAAESKN99EBF8J2BHD',
+        'validations/02AURNEWAAAESKN99EBF8J2BHD',
         body=api_resp,
         status=404)