[api-ref] Refactor share instance export locations API documentation

This patch makes share instance export locations API documentation
more readable and maintainable.

Change-Id: I4b4771bbe9f2689162c84f085cae159f364ecb20
This commit is contained in:
Ha Van Tu 2016-12-27 14:50:48 +07:00
parent ba8e8d1ada
commit 4fc3524bf8

View File

@ -28,7 +28,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_1
- tenant_id: tenant_id_path
- share_instance_id: share_instance_id
Response parameters
@ -36,11 +36,11 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: id_5
- share_instance_id: share_instance_id_1
- path: path
- is_admin_only: is_admin_only
- preferred: preferred
- 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
----------------
@ -64,8 +64,8 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_1
- share_instance_id: share_instance_id
- tenant_id: tenant_id_path
- share_instance_id: export_location_share_instance_id
- export_location_id: export_location_id
Response parameters
@ -73,13 +73,13 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: id_5
- share_instance_id: share_instance_id_1
- path: path
- is_admin_only: is_admin_only
- preferred: preferred
- created_at: created_at_5
- updated_at: updated_at_2
- 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
----------------