[
https://issues.apache.org/jira/browse/CLOUDSTACK-9088?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15033543#comment-15033543
]
ASF GitHub Bot commented on CLOUDSTACK-9088:
--------------------------------------------
Github user DaanHoogland commented on the pull request:
https://github.com/apache/cloudstack/pull/1126#issuecomment-160941315
There is two problems to solve here;
1. how to document the api in a concise way. The information you are
providing is very useful and I think it makes sense to put it there
2. how to use the api. the formatting of the information is specific to the
client so I would try to use a more formal format or as in my exmple below in
json. I don't have a universal answer to this but in this case I would say,
though it is somewhate oververbose:
```
migrateto : [ {
volume: '71f43cd6-69b0-4d3b-9fbc-67f50963d60b',
pool: 'a382f181-3d2b-4413-b92d-b8931befa7e1'
},
{
volume: '88de0173-55c0-4c1c-a269-83d0279eeedf',
pool: '95d6e97c-6766-4d67-9a30-c449c15011d1'
},
{
volume: '1b331390-59f2-4796-9993-bf11c6e76225',
pool: '41fdb564-9d3b-447d-88ed-7628f7640cbc'
} ]
This example in cloudmoney:
migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=<a382f181-3d2b-4413-b92d-b8931befa7e1>&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>
```
> migrateto parameter associated with migrateVirtualMachineWithVolume API needs
> an example
> ----------------------------------------------------------------------------------------
>
> Key: CLOUDSTACK-9088
> URL: https://issues.apache.org/jira/browse/CLOUDSTACK-9088
> Project: CloudStack
> Issue Type: Bug
> Security Level: Public(Anyone can view this level - this is the
> default.)
> Components: API, Doc
> Reporter: Anshul Gangwar
> Assignee: Anshul Gangwar
>
> ISSUE:
> API docs for migrateVirtualMachineWithVolume API does not clearly state the
> format for parameter "migrateto". The doc suggests that it accepts
> volume/pool pair but fails to mention:
> 1. Format.
> 2. If value for volume/pool should be name, ID or UUID.
> 3. Whether "pool" referenced here is source or target.
> It may be difficult for users to perceive that the format needs to something
> like ...&migrateto[0].volume=<UUID>&migrateto[0].pool=<UUID>&...
> We need to provide example for better understanding like we have done for
> "iptonetworklist" parameter associated with deployVirtualMachine API.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
