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
This commit is contained in:
parent
6d01f3f07b
commit
2edd8e6531
|
@ -621,8 +621,8 @@ Example
|
||||||
"action_lifecycle": "Failed"
|
"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.
|
Allows for drilldown to validation detailed info.
|
||||||
|
|
||||||
Entity Structure
|
Entity Structure
|
||||||
|
@ -633,8 +633,8 @@ The detailed information for a validation
|
||||||
|
|
||||||
{ TBD }
|
{ 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.
|
Returns the validation detail by Id for the supplied action Id.
|
||||||
|
|
||||||
Responses
|
Responses
|
||||||
|
@ -733,8 +733,8 @@ Entity Structure
|
||||||
^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^
|
||||||
None, there is no associated response entity for this resource
|
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
|
Trigger a control action against an activity.- this includes: pause, unpause
|
||||||
|
|
||||||
Responses
|
Responses
|
||||||
|
|
|
@ -30,7 +30,7 @@ class ApiPaths(enum.Enum):
|
||||||
COMMIT_CONFIG = _BASE_URL + 'commitconfigdocs'
|
COMMIT_CONFIG = _BASE_URL + 'commitconfigdocs'
|
||||||
POST_GET_ACTIONS = _BASE_URL + 'actions'
|
POST_GET_ACTIONS = _BASE_URL + 'actions'
|
||||||
GET_ACTION_DETAIL = _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_DETAIL = _BASE_URL + 'actions/{}/steps/{}'
|
||||||
GET_STEP_LOG = _BASE_URL + 'actions/{}/steps/{}/logs'
|
GET_STEP_LOG = _BASE_URL + 'actions/{}/steps/{}/logs'
|
||||||
POST_CONTROL_ACTION = _BASE_URL + 'actions/{}/control/{}'
|
POST_CONTROL_ACTION = _BASE_URL + 'actions/{}/control/{}'
|
||||||
|
|
|
@ -168,7 +168,7 @@ def test_get_val_details(*args):
|
||||||
action_id = 'GoodAction'
|
action_id = 'GoodAction'
|
||||||
validation_id = 'Validation'
|
validation_id = 'Validation'
|
||||||
result = shipyard_client.get_validation_detail(action_id, validation_id)
|
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)
|
shipyard_client.get_endpoint(), action_id, validation_id)
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -171,7 +171,7 @@ def test_describe_validation(*args):
|
||||||
responses.add(
|
responses.add(
|
||||||
responses.GET,
|
responses.GET,
|
||||||
'http://shiptest/actions/01BTTMFVDKZFRJM80FGD7J1AKN/'
|
'http://shiptest/actions/01BTTMFVDKZFRJM80FGD7J1AKN/'
|
||||||
'validationdetails/02AURNEWAAAESKN99EBF8J2BHD',
|
'validations/02AURNEWAAAESKN99EBF8J2BHD',
|
||||||
body=GET_VALIDATION_API_RESP,
|
body=GET_VALIDATION_API_RESP,
|
||||||
status=200)
|
status=200)
|
||||||
|
|
||||||
|
@ -197,7 +197,7 @@ def test_describe_validation_not_found(*args):
|
||||||
responses.add(
|
responses.add(
|
||||||
responses.GET,
|
responses.GET,
|
||||||
'http://shiptest/actions/01BTTMFVDKZFRJM80FGD7J1AKN/'
|
'http://shiptest/actions/01BTTMFVDKZFRJM80FGD7J1AKN/'
|
||||||
'validationdetails/02AURNEWAAAESKN99EBF8J2BHD',
|
'validations/02AURNEWAAAESKN99EBF8J2BHD',
|
||||||
body=api_resp,
|
body=api_resp,
|
||||||
status=404)
|
status=404)
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue