8b830df305
Make space for v2. It should not break too much existing links, only the links to local anchors (like #clusters, #jobs, etc) will be broken, because it is not possible to redirect server-side based on an URL fragment like that. Luckily the generated content ends all in the same HTML page, so the old links will end up in the new top-level index which points to the index for v1.1 API documentation (and later for v2). Not too bad. Change-Id: I9a75e6567798b8d6d3deed8fc66e362ad2d86b5a
188 lines
2.8 KiB
ReStructuredText
188 lines
2.8 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/{project_id}/plugins/{plugin_name}
|
|
|
|
Shows details for a plugin.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes: 400, 500
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: url_project_id
|
|
- plugin_name: url_plugin_name
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- versions: versions
|
|
- title: title
|
|
- description: description_plugin
|
|
- name: plugin_name
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/plugins/plugin-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
List plugins
|
|
============
|
|
|
|
.. rest_method:: GET /v1.1/{project_id}/plugins
|
|
|
|
Lists all registered plugins.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes: 400, 500
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: url_project_id
|
|
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- title: title
|
|
- versions: versions
|
|
- plugins: plugins
|
|
- description: description_plugin
|
|
- name: plugin_name
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/plugins/plugins-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Show plugin version details
|
|
===========================
|
|
|
|
.. rest_method:: GET /v1.1/{project_id}/plugins/{plugin_name}/{version}
|
|
|
|
Shows details for a plugin version.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes: 400, 500
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: url_project_id
|
|
- plugin_name: url_plugin_name
|
|
- version: version
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- versions: versions
|
|
- title: title
|
|
- description: description_plugin
|
|
- name: plugin_name
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/plugins/plugin-version-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Update plugin details
|
|
=====================
|
|
|
|
.. rest_method:: PATCH /v1.1/{project_id}/plugins/{plugin_name}
|
|
|
|
Updates details for a plugin.
|
|
|
|
|
|
Normal response codes: 202
|
|
Error response codes: 400, 500
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: url_project_id
|
|
- plugin_name: url_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_plugin
|
|
- name: plugin_name
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/plugins/plugin-update-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|