deb-sahara/api-ref/source/plugins.inc
Shu Yingya 3a4a3a09f1 [Doc] add description of "plugin update" to api ref
There is a new method "plugins_update" in file[1],
but still didn't add into doc.

[1]: https://github.com/openstack/sahara/blob/master/sahara/api/v10.py#L216-L221

Change-Id: Ieb8e5cb616b27bb997162229e6f3867f5a0a2c3f
2016-09-01 06:17:31 +08:00

188 lines
2.7 KiB
ReStructuredText

.. -*- rst -*-
=======
Plugins
=======
A plugin object defines the Hadoop or Spark version that it can
install and which configurations can be set for the cluster.
Show plugin details
===================
.. rest_method:: GET /v1.1/{tenant_id}/plugins/{plugin_name}
Shows details for a plugin.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- plugin_name: plugin_name
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- versions: versions
- title: title
- description: description
- name: name
Response Example
----------------
.. literalinclude:: samples/plugins/plugin-show-response.json
:language: javascript
List plugins
============
.. rest_method:: GET /v1.1/{tenant_id}/plugins
Lists all registered plugins.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- title: title
- versions: versions
- plugins: plugins
- description: description
- name: name
Response Example
----------------
.. literalinclude:: samples/plugins/plugins-list-response.json
:language: javascript
Show plugin version details
===========================
.. rest_method:: GET /v1.1/{tenant_id}/plugins/{plugin_name}/{version}
Shows details for a plugin version.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- plugin_name: plugin_name
- version: version
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- versions: versions
- title: title
- description: description
- name: name
Response Example
----------------
.. literalinclude:: samples/plugins/plugin-version-show-response.json
:language: javascript
Update plugin details
=====================
.. rest_method:: PATCH /v1.1/{tenant_id}/plugins/{plugin_name}
Updates details for a plugin.
Normal response codes:202
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- plugin_name: plugin_name
Request Example
---------------
.. literalinclude:: samples/plugins/plugin-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- title: title
- versions: versions
- description: description
- name: name
Response Example
----------------
.. literalinclude:: samples/plugins/plugin-update-response.json
:language: javascript