cloudstack-users mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Rajsekhar K <rajsekharkpa...@gmail.com>
Subject Re: [Proposal] Template for CloudStack API Reference Pages
Date Thu, 19 Nov 2015 08:31:13 GMT
Thanks.

Format is to domonstrate the usage of the API. I think that the format
along with an example would help users understand how they can use the API.

For example, the migrateto parameter in the API has the following format:

migrateto[volume-index].volume=<uuid>&migrateto[volume-index].pool=<uuid>Where,
[volume-index] indicates the index to identify the volume that you want to
migrate, volume=<uuid> indicates the UUID of the volume that you want to
migrate, and pool=<uuid> indicates the UUID of the pool where you want to
migrate the volume.

An example for this format is:

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>

Thanks,
Rajsekhar

On Wed, Nov 11, 2015 at 10:40 AM, Daejuan Jacobs <daejuan@gmail.com> wrote:

> I assume by "Format" you mean data type.
>
> But I think this looks good. It's simple, yet it manages to nail all the
> points you need when developing on a software's API.
>
> On Tue, Nov 10, 2015 at 8:33 AM Rajsekhar K <rajsekharkpally@gmail.com>
> wrote:
>
> > Hi, All,
> >
> > This is the proposal for a new template for CloudStack API reference
> > pages. This template is based on the reference page templates for REST
> APIs.
> >
> > Please find attached the following documents for your review:
> >
> >    - Template for normal and asynchronous CloudStack API references.
> >    - Sample API reference page using the template for a CloudStack API
> >    (listZones).
> >
> >
> > Please review this template and let me know your thoughts on this.
> >
> > Thanks,
> > Rajsekhar
> >
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message