(QENG-3919) Update API docs

We consider it a bug that the actual behavior was not this behavior, but the
documentation was also silent on this point.
This commit is contained in:
Rick Bradley 2016-05-24 14:09:38 -05:00
parent 2ea47a98be
commit 2f9bc4023b

4
API.md
View file

@ -117,6 +117,8 @@ $ curl -d '{"debian-7-i386":"2","debian-7-x86_64":"1"}' --url vmpooler.company.c
} }
``` ```
**NOTE: Returns either all requested VMs or no VMs.**
##### POST /vm/<pool> ##### POST /vm/<pool>
Check-out a VM or VMs. Check-out a VM or VMs.
@ -156,6 +158,8 @@ $ curl -d --url vmpooler.company.com/api/v1/vm/debian-7-i386+debian-7-i386+debia
} }
``` ```
**NOTE: Returns either all requested VMs or no VMs.**
##### GET /vm/<hostname> ##### GET /vm/<hostname>
Query a checked-out VM. Query a checked-out VM.