From a2a17c06252a98c293e2c547ebe9f54b15366193 Mon Sep 17 00:00:00 2001
From: fpxie <fpxie@fiberhome.com>
Date: Mon, 30 Apr 2018 18:10:41 +0800
Subject: [PATCH] Update the parameter explain when updating a volume
 attachment

When we update a volume attachment in nova api, we use volume_id instead
of attachment_id in params in latest api.

Change-Id: I5fc4d0ba3bb1c49dfaba2b2eed056441509cb9da
---
 api-ref/source/os-volume-attachments.inc |  8 ++++++--
 api-ref/source/parameters.yaml           | 14 +++++++-------
 2 files changed, 13 insertions(+), 9 deletions(-)

diff --git a/api-ref/source/os-volume-attachments.inc b/api-ref/source/os-volume-attachments.inc
index 1f5042fe3988..99a125562a53 100644
--- a/api-ref/source/os-volume-attachments.inc
+++ b/api-ref/source/os-volume-attachments.inc
@@ -138,13 +138,17 @@ Response
 Update a volume attachment
 ==========================
 
-.. rest_method:: PUT /servers/{server_id}/os-volume_attachments/{attachment_id}
+.. rest_method:: PUT /servers/{server_id}/os-volume_attachments/{volume_id}
 
 Update a volume attachment.
 
 .. note:: This action only valid when the server is in ACTIVE, PAUSED and RESIZED state,
           or a conflict(409) error will be returned.
 
+Policy defaults enable only users with the administrative role or
+the owner of the server to perform this operation. Cloud providers
+can change these permissions through the ``policy.json`` file.
+
 Normal response codes: 202
 
 Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
@@ -155,7 +159,7 @@ Request
 .. rest_parameters:: parameters.yaml
 
   - server_id: server_id_path
-  - attachment_id: attachment_id
+  - volume_id: volume_id_swap_src
   - volumeAttachment: volumeAttachment_put
   - volumeId: volumeId_swap
 
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 11c0364b44d4..b1b1d7683380 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -87,12 +87,6 @@ api_version:
   type: string
   description: >
     The API version as returned in the links from the ``GET /`` call.
-attachment_id:
-  description: |
-    The UUID of the attachment.
-  in: path
-  required: true
-  type: string
 before_timestamp:
   description: |
     Filters the response by the date and time before which to list usage
@@ -349,6 +343,12 @@ volume_id_path:
   in: path
   required: true
   type: string
+volume_id_swap_src:
+  description: |
+    The UUID of the volume being replaced.
+  in: path
+  required: true
+  type: string
 volume_id_to_detach_path:
   description: |
     The UUID of the volume to detach.
@@ -6675,7 +6675,7 @@ volumeAttachment_post:
 volumeAttachment_put:
   description: |
     A dictionary representation of a volume attachment containing the field
-    ``volumeId``.
+    ``volumeId`` which is the UUID of the replacement volume.
   in: body
   required: true
   type: object