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:
committed by
Brian Rosmaita
parent
c98f88208d
commit
70912ef15e
@@ -1870,9 +1870,9 @@ multiattach_resp:
|
|||||||
type: boolean
|
type: boolean
|
||||||
name:
|
name:
|
||||||
description: |
|
description: |
|
||||||
The name of the Volume Transfer.
|
The name of the object.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: false
|
||||||
type: string
|
type: string
|
||||||
name_backend_pool:
|
name_backend_pool:
|
||||||
description: |
|
description: |
|
||||||
@@ -2635,6 +2635,12 @@ snapshot_id_source_vol:
|
|||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
snapshot_name:
|
||||||
|
description: |
|
||||||
|
The name of the snapshot.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
snapshot_obj:
|
snapshot_obj:
|
||||||
description: |
|
description: |
|
||||||
A ``snapshot`` object.
|
A ``snapshot`` object.
|
||||||
@@ -2880,13 +2886,18 @@ transfer:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: object
|
type: object
|
||||||
|
transfer_name:
|
||||||
|
description: |
|
||||||
|
The name of the volume transfer.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
transfer_obj_id:
|
transfer_obj_id:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the volume transfer.
|
The UUID of the volume transfer.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
|
||||||
transfers:
|
transfers:
|
||||||
description: |
|
description: |
|
||||||
List of transfer details.
|
List of transfer details.
|
||||||
|
|||||||
@@ -50,7 +50,7 @@ Response Parameters
|
|||||||
- volume_id: volume_id
|
- volume_id: volume_id
|
||||||
- id: id
|
- id: id
|
||||||
- links: links
|
- links: links
|
||||||
- name: name
|
- name: transfer_name
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|||||||
@@ -417,7 +417,7 @@ Request
|
|||||||
- snapshot_id: snapshot_id_path
|
- snapshot_id: snapshot_id_path
|
||||||
- snapshot: snapshot_obj
|
- snapshot: snapshot_obj
|
||||||
- description: description_snap
|
- description: description_snap
|
||||||
- name: name
|
- name: snapshot_name
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|||||||
Reference in New Issue
Block a user