cinder/api-ref/source/v3/volumes-v3-extensions.inc
whoami-rajat 609412fcd2 Improve/Clean api-ref parameters
The parameters with name like example_1, example_2 ... etc. cause
confusion while updating the api-ref docs like the examples below:

https://review.openstack.org/#/c/609639/
https://review.openstack.org/#/c/609611/

This patch does the following changes :
1) Replace numbering in the parameter with relevant names
2) Clean up unused parameters

Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-11-05 10:47:14 +05:30

59 lines
793 B
ReStructuredText

.. -*- rst -*-
API extensions (extensions)
===========================
List Known API extensions
~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v3/{project_id}/extensions
Lists Block Storage API extensions.
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 200
.. rest_status_code:: error ../status.yaml
- 300
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- updated: updated_at
- description: description_extn
- links: links
- namespace: namespace
- alias: alias
- name: name
Response Example
----------------
.. literalinclude:: ./samples/extensions-list-response.json
:language: javascript