Return-Path: X-Original-To: apmail-cloudstack-dev-archive@www.apache.org Delivered-To: apmail-cloudstack-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 541DA18AC7 for ; Tue, 1 Dec 2015 11:32:17 +0000 (UTC) Received: (qmail 50812 invoked by uid 500); 1 Dec 2015 11:32:17 -0000 Delivered-To: apmail-cloudstack-dev-archive@cloudstack.apache.org Received: (qmail 50752 invoked by uid 500); 1 Dec 2015 11:32:16 -0000 Mailing-List: contact dev-help@cloudstack.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list dev@cloudstack.apache.org Received: (qmail 50741 invoked by uid 99); 1 Dec 2015 11:32:16 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 01 Dec 2015 11:32:16 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 6A0A2E03EC; Tue, 1 Dec 2015 11:32:16 +0000 (UTC) From: DaanHoogland To: dev@cloudstack.apache.org Reply-To: dev@cloudstack.apache.org References: In-Reply-To: Subject: [GitHub] cloudstack pull request: CLOUDSTACK-9088: Update the description f... Content-Type: text/plain Message-Id: <20151201113216.6A0A2E03EC@git1-us-west.apache.org> Date: Tue, 1 Dec 2015 11:32:16 +0000 (UTC) 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=&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> ``` --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastructure@apache.org or file a JIRA ticket with INFRA. ---