openstack/deb-sahara
Code Issues Proposed changes

Update doc for REST endpoint convert-config

Browse Source 
The convert-config REST endpoint documentation is incorrect.
It requires the template-name at the end.

Change-Id: I0061365b8d74bb5337a8a6e31a0d68746121dff1
Closes-Bug: 1312409
This commit is contained in:
Patrick Amor 2014-07-03 11:42:25 -07:00
parent 2841962f43
commit 953f829da5
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/source/restapi/rest_api_v1.0.rst
View File

@ -80,19 +80,19 @@ A Plugin object provides information about what Hadoop distribution/version it c
**Plugins ops**
+-----------------+-------------------------------------------------------------------+-----------------------------------------------------+
| Verb | URI | Description |
+=================+===================================================================+=====================================================+
| GET | /v1.0/{tenant_id}/plugins | Lists all plugins registered in Sahara. |
+-----------------+-------------------------------------------------------------------+-----------------------------------------------------+
| GET | /v1.0/{tenant_id}/plugins/{plugin_name} | Shows short information about specified plugin. |
+-----------------+-------------------------------------------------------------------+-----------------------------------------------------+
| GET | /v1.0/{tenant_id}/plugins/{plugin_name}/{version} | Shows detailed information for plugin, like |
| | | node_processes, required_image_tags and configs. |
+-----------------+-------------------------------------------------------------------+-----------------------------------------------------+
| POST | /v1.0/{tenant_id}/plugins/{plugin_name}/{version}/convert-config | Converts file-based cluster config to Cluster |
| | | Template Object |
+-----------------+-------------------------------------------------------------------+-----------------------------------------------------+
+-----------------+-----------------------------------------------------------------------------------+-----------------------------------------------------+
| Verb | URI | Description |
+=================+===================================================================================+=====================================================+
| GET | /v1.0/{tenant_id}/plugins | Lists all plugins registered in Sahara. |
+-----------------+-----------------------------------------------------------------------------------+-----------------------------------------------------+
| GET | /v1.0/{tenant_id}/plugins/{plugin_name} | Shows short information about specified plugin. |
+-----------------+-----------------------------------------------------------------------------------+-----------------------------------------------------+
| GET | /v1.0/{tenant_id}/plugins/{plugin_name}/{version} | Shows detailed information for plugin, like |
| | | node_processes, required_image_tags and configs. |
+-----------------+-----------------------------------------------------------------------------------+-----------------------------------------------------+
| POST | /v1.0/{tenant_id}/plugins/{plugin_name}/{version}/convert-config/{template-name} | Converts file-based cluster config to Cluster |
| | | Template Object |
+-----------------+-----------------------------------------------------------------------------------+-----------------------------------------------------+
**Examples**
@ -258,7 +258,7 @@ This operation does not require a request body.
2.4 Convert configuration file
------------------------------
.. http:post:: /v1.0/{tenant_id}/plugins/{plugin_name}/{version}/convert-config
.. http:post:: /v1.0/{tenant_id}/plugins/{plugin_name}/{version}/convert-config/{template-name}
Normal Response Code: 202 (ACCEPTED)
@ -273,7 +273,7 @@ The request body should contain configuration file.
.. sourcecode:: http
POST http://sahara/v1.0/775181/plugins/some-plugin/1.1/convert-config
POST http://sahara/v1.0/775181/plugins/some-plugin/1.1/convert-config/tname
**response**