api-ref: Fix "name" parameter

Prior to this change, the "name" field in
the response for "Update a snapshot's metadata"
referred to volume transfers instead of snapshots.

Make "name" a generic parameter in case it is reused
in other APIs, and make specific parameters for
snapshots and transfers.

(Similar to I0b0a692139)

Change-Id: Ifb93bd1b20c216fd29ea90c4ac70709bee569d1d
This commit is contained in:
Eric Harney 2021-03-09 17:22:29 -05:00 committed by Brian Rosmaita
parent c98f88208d
commit 70912ef15e
3 changed files with 16 additions and 5 deletions

View File

@ -1870,9 +1870,9 @@ multiattach_resp:
type: boolean
name:
description: |
The name of the Volume Transfer.
The name of the object.
in: body
required: true
required: false
type: string
name_backend_pool:
description: |
@ -2635,6 +2635,12 @@ snapshot_id_source_vol:
in: body
required: false
type: string
snapshot_name:
description: |
The name of the snapshot.
in: body
required: false
type: string
snapshot_obj:
description: |
A ``snapshot`` object.
@ -2880,13 +2886,18 @@ transfer:
in: body
required: true
type: object
transfer_name:
description: |
The name of the volume transfer.
in: body
required: true
type: string
transfer_obj_id:
description: |
The UUID of the volume transfer.
in: body
required: true
type: string
transfers:
description: |
List of transfer details.

View File

@ -50,7 +50,7 @@ Response Parameters
- volume_id: volume_id
- id: id
- links: links
- name: name
- name: transfer_name
Response Example
----------------

View File

@ -417,7 +417,7 @@ Request
- snapshot_id: snapshot_id_path
- snapshot: snapshot_obj
- description: description_snap
- name: name
- name: snapshot_name
Request Example
---------------