api-ref: fix the response parameter for multiattach

The multiattach parameter is optional when creating
a volume but is required to be in the response when
showing a volume.

This fixes the parameter usage, renames the parameters
so they are more clear (multiattach_1 was for the response
but was never used), and also adds a note to the multiattach
request parameter about how support is dependent on the volume
type being used to create the volume.

Change-Id: Ifaa29140a8e8a9b8090f33fb83e4bb5c98ee847f

api-ref/source/v2/parameters.yaml

@@ -1032,14 +1032,16 @@ mountpoint:
   in: body
   required: true
   type: string
-multiattach:
+multiattach_req:
   description: |
     To enable this volume to attach to more than one
     server, set this value to ``true``. Default is ``false``.
+    Note that support for multiattach volumes depends on the volume
+    type being used.
   in: body
   required: false
   type: boolean
-multiattach_1:
+multiattach_resp:
   description: |
     If true, this volume can attach to more than one
     instance.

api-ref/source/v2/volumes-v2-volumes.inc

@@ -106,7 +106,7 @@ Response Parameters
    - status: status_3
    - volume_image_metadata: volume_image_metadata
    - description: description
-   - multiattach: multiattach
+   - multiattach: multiattach_resp
    - source_volid: source_volid
    - consistencygroup_id: consistencygroup_id
    - os-vol-mig-status-attr:name_id: os-vol-mig-status-attr:name_id
@@ -175,7 +175,7 @@ Request
    - size: size
    - description: description_9
    - imageRef: imageRef
-   - multiattach: multiattach
+   - multiattach: multiattach_req
    - availability_zone: availability_zone
    - source_volid: source_volid
    - name: name_13
@@ -215,7 +215,7 @@ Response Parameters
    - metadata: metadata
    - status: status_3
    - description: description
-   - multiattach: multiattach
+   - multiattach: multiattach_resp
    - source_volid: source_volid
    - volume: volume
    - consistencygroup_id: consistencygroup_id
@@ -322,7 +322,7 @@ Response Parameters
    - status: status_3
    - volume_image_metadata: volume_image_metadata
    - description: description
-   - multiattach: multiattach
+   - multiattach: multiattach_resp
    - source_volid: source_volid
    - volume: volume
    - consistencygroup_id: consistencygroup_id
@@ -394,7 +394,7 @@ Response Parameters
    - metadata: metadata_3
    - status: status_3
    - description: description
-   - multiattach: multiattach
+   - multiattach: multiattach_resp
    - source_volid: source_volid
    - volume: volume
    - consistencygroup_id: consistencygroup_id

api-ref/source/v3/parameters.yaml

@@ -1710,14 +1710,16 @@ mountpoint:
   in: body
   required: true
   type: string
-multiattach:
+multiattach_req:
   description: |
     To enable this volume to attach to more than one
     server, set this value to ``true``. Default is ``false``.
+    Note that support for multiattach volumes depends on the volume
+    type being used.
   in: body
   required: false
   type: boolean
-multiattach_1:
+multiattach_resp:
   description: |
     If true, this volume can attach to more than one
     instance.

api-ref/source/v3/volumes-v3-volumes.inc

@@ -113,7 +113,7 @@ Response Parameters
    - status: status_3
    - volume_image_metadata: volume_image_metadata
    - description: description_9
-   - multiattach: multiattach
+   - multiattach: multiattach_resp
    - source_volid: source_volid
    - consistencygroup_id: consistencygroup_id
    - os-vol-mig-status-attr:name_id: os-vol-mig-status-attr:name_id
@@ -186,7 +186,7 @@ Request
    - availability_zone: availability_zone
    - source_volid: source_volid
    - description: description_5
-   - multiattach: multiattach
+   - multiattach: multiattach_req
    - snapshot_id: snapshot_id
    - backup_id: backup_id_1
    - name: name_13
@@ -223,7 +223,7 @@ Response Parameters
    - metadata: metadata
    - status: status_3
    - description: description_9
-   - multiattach: multiattach
+   - multiattach: multiattach_resp
    - source_volid: source_volid
    - volume: volume
    - consistencygroup_id: consistencygroup_id
@@ -337,7 +337,7 @@ Response Parameters
    - status: status_3
    - volume_image_metadata: volume_image_metadata
    - description: description_9
-   - multiattach: multiattach
+   - multiattach: multiattach_resp
    - source_volid: source_volid
    - volume: volume
    - consistencygroup_id: consistencygroup_id
@@ -410,7 +410,7 @@ Response Parameters
    - metadata: metadata
    - status: status_3
    - description: description_9
-   - multiattach: multiattach
+   - multiattach: multiattach_resp
    - source_volid: source_volid
    - volume: volume
    - consistencygroup_id: consistencygroup_id