609412fcd2
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
49 lines
712 B
ReStructuredText
49 lines
712 B
ReStructuredText
.. -*- rst -*-
|
|
|
|
API version details
|
|
===================
|
|
|
|
|
|
Show API v3 details
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/
|
|
|
|
Shows details for Block Storage API v3.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error ../status.yaml
|
|
|
|
- 403
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: version_status
|
|
- updated: version_updated
|
|
- links: links_res
|
|
- min_version: version_min
|
|
- version: version_max
|
|
- media-types: media_types
|
|
- id: version_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/version-show-response.json
|
|
:language: javascript
|
|
|
|
|