api-ref: Fix "id" parameter
The parameter "id" was used for volume transfer and other various APIs, resulting in things like consistency group snapshot APIs indicating that they return volume transfer ids. Make "id" generic for those cases and make a specific "transfer_id" parameter for volume transfers to prevent this problem in other places. Change-Id: I0b0a69213910c33570453cd961e10e22941369e9
This commit is contained in:
parent
a4e64d839f
commit
c98f88208d
@ -43,7 +43,7 @@ Response Parameters
|
||||
|
||||
- transfer: transfer
|
||||
- volume_id: volume_id
|
||||
- id: id
|
||||
- id: transfer_obj_id
|
||||
- links: links
|
||||
- name: name
|
||||
|
||||
@ -101,7 +101,7 @@ Response Parameters
|
||||
- links: links
|
||||
- created_at: created_at
|
||||
- volume_id: volume_id
|
||||
- id: id
|
||||
- id: transfer_obj_id
|
||||
- name: name
|
||||
|
||||
Response Example
|
||||
@ -141,7 +141,7 @@ Response Parameters
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- volume_id: volume_id
|
||||
- id: id
|
||||
- id: transfer_obj_id
|
||||
- links: links
|
||||
- name: name
|
||||
|
||||
@ -184,7 +184,7 @@ Response Parameters
|
||||
|
||||
- created_at: created_at
|
||||
- volume_id: volume_id
|
||||
- id: id
|
||||
- id: transfer_obj_id
|
||||
- links: links
|
||||
- name: name
|
||||
|
||||
@ -250,7 +250,7 @@ Response Parameters
|
||||
- transfers: transfers
|
||||
- created_at: created_at
|
||||
- volume_id: volume_id
|
||||
- id: id
|
||||
- id: transfer_obj_id
|
||||
- links: links
|
||||
- name: name
|
||||
|
||||
|
@ -1408,7 +1408,7 @@ hosts:
|
||||
type: object
|
||||
id:
|
||||
description: |
|
||||
The UUID of the volume transfer.
|
||||
The UUID of the object.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
@ -2880,6 +2880,13 @@ transfer:
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
transfer_obj_id:
|
||||
description: |
|
||||
The UUID of the volume transfer.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
|
||||
transfers:
|
||||
description: |
|
||||
List of transfer details.
|
||||
|
Loading…
Reference in New Issue
Block a user