manila/api-ref/source/share-instance-export-locations.inc
junboli 6985c77ee5 Api ref contains incorrect parameters.
Things like following is in api-ref, need to be correct.
  1. use share_id and remove share_id_4
  2. export_location_id_path param is required
  3. security_service_id is required not optional
This patch is to fix these.

Change-Id: Ic811095b85a0460d3c6bedc9526d8ed64248de4c
Closes-bug: #1719543
2017-11-17 13:26:08 +08:00

89 lines
2.2 KiB
ReStructuredText

.. -*- rst -*-
================================================
Share instance export locations (since API v2.9)
================================================
Set of APIs used to view export locations of share instances.
By default, these APIs are admin-only. Use the ``policy.json`` file
to grant permissions for these actions to other roles.
Lists all export locations for a share instance.
Show details of an export location belonging to a share instance.
List export locations
=====================
.. rest_method:: GET /v2/{tenant_id}/share_instances/{share_instance_id}/export_locations
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- share_instance_id: share_instance_id
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: export_location_id
- share_instance_id: export_location_share_instance_id
- path: export_location_path
- is_admin_only: export_location_is_admin_only
- preferred: export_location_preferred
Response example
----------------
.. literalinclude:: samples/export-location-list-response.json
:language: javascript
Show single export location
===========================
.. rest_method:: GET /v2/{tenant_id}/share_instances/{share_instance_id}/export_locations/{export_location_id}
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- share_instance_id: share_instance_id
- export_location_id: export_location_id_path
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: export_location_id
- share_instance_id: export_location_share_instance_id
- path: export_location_path
- is_admin_only: export_location_is_admin_only
- preferred: export_location_preferred
- created_at: export_location_created_at
- updated_at: export_location_updated_at
Response example
----------------
.. literalinclude:: samples/export-location-show-response.json
:language: javascript