manila/api-ref/source/extensions.inc
junboli acf8c99e9b Use rest_status_code for api-ref response codes
Rather than our freeform way of listing response codes in our
api-ref, we should be using the os-api-ref extension option to
get nicely formatted response code listings.

https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code

Change-Id: Ibafafa2f9c3b301b5cdd9b1cb3b8b6d678faa731
2018-03-24 01:07:16 +00:00

53 lines
814 B
ReStructuredText

.. -*- rst -*-
==============
API extensions
==============
Lists available Shared File Systems API extensions.
List extensions
===============
.. rest_method:: GET /v2/{tenant_id}/extensions
Lists all extensions.
Response codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- name: extension_name
- links: extension_links
- description: extension_description
- alias: extension_alias
- updated: extension_updated
Response example
----------------
.. literalinclude:: samples/extensions-list-response.json
:language: javascript