Re: [Kimchi-devel] [PATCHv6 3/8] Storage server: Update API.md
On 2014年01月14日 12:05, Sheldon wrote:
On 01/08/2014 11:50 PM, lvroyce0210(a)gmail.com wrote:
> From: Royce Lv <lvroyce(a)linux.vnet.ibm.com>
>
> Update API.md to specify storage server api.
>
> Signed-off-by: Royce Lv <lvroyce(a)linux.vnet.ibm.com>
> ---
> docs/API.md | 13 +++++++++++++
> 1 file changed, 13 insertions(+)
>
> diff --git a/docs/API.md b/docs/API.md
> index 0013e86..7a25eda 100644
> --- a/docs/API.md
> +++ b/docs/API.md
> @@ -456,6 +456,19 @@ creation.
> not tested yet
> * **POST**: *See Configuration Actions*
>
> +**Actions (POST):**
> +
> +*No actions defined*
> +
> +### Collection: Storage Servers
> +
> +**URI:** /storageservers
> +
> +**Methods:**
> +
> +* **GET**: Retrieve a summarized list of used storage servers.
> + * target_type: Filter server list with given type, currently
> support 'netfs'.
> +
not sure API.md reader can know well this is a query params?
GET /storageservers ?target_type=netfs
According to http://www.w3schools.com/tags/ref_httpmethods.asp
I think people use GET parameter knows it, I added to the commit msg
about the usage.
Do you think we need to doc in the API.md about GET parameter usage?
Personally I suppose not.
you can check with the UI guys.
> ### Collection: Distros
>
> **URI:** /config/distros