8872: Fixups from code review.

[arvados.git] / doc / api / methods / virtual_machines.html.textile.liquid

diff --git a/doc/api/methods/virtual_machines.html.textile.liquid b/doc/api/methods/virtual_machines.html.textile.liquid
index 070569ceef7580a3e175158914ca1a00f3dfc69f..390abdc595893964893a151387432185a04ba9af 100644 (file)
--- a/doc/api/methods/virtual_machines.html.textile.liquid
+++ b/doc/api/methods/virtual_machines.html.textile.liquid
@@ -6,7 +6,9 @@ title: "virtual_machines"
 
 ...
 
+See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
 
+API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/virtual_machines@
 
 Required arguments are displayed in %{background:#ccffcc}green%.
 
@@ -31,34 +33,44 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
 
-h2. destroy
+h2. get
 
-destroy virtual_machines
+Gets a VirtualMachine's metadata by UUID.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+{background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
 
-h2. get
+h2(#logins). logins
 
-Gets a VirtualMachine's metadata by UUID.
+Get a list of SSH keys and account names that should be able to log in to a given virtual machine.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
+{background:#ccffcc}.|uuid|string||path||
+
+The response is a "resource list":{{site.baseurl}}/api/resources.html#resourceList with @kind@ set to @"arvados#HashList"@. Each item is a hash with the following keys:
+
+table(table table-bordered table-condensed).
+|_. Key|_. Value type|_. Description|_. Example|
+|username|string|Name of the Unix login account to which the user should be able to log in|@"jsmith"@|
+|hostname|string|Hostname of the virtual machine|@"shell.xyzzy.arvadosapi.com"@|
+|public_key|string|SSH public key|@"ssh-rsa AAAAB3NzaC1yc2E..."@|
+|user_uuid|string|UUID of the user who should be able to log in|@"xyzzy-tpzed-mv4d7dy7n91te11"@|
+|virtual_machine_uuid|string|UUID of the "VirtualMachine resource":{{site.baseurl}}/api/schema/VirtualMachine.html|@"xyzzy-2x53u-kvszmclnbjuv8xc"@|
+|authorized_key_uuid|string|UUID of the "AuthorizedKey resource":{{site.baseurl}}/api/schema/AuthorizedKey.html|@"xyzzy-fngyi-v9p0cyfmjxbio64"@|
 
 h2. get_all_logins
 
-get_all_logins virtual_machines
+Get a list, for every virtual machine in the system, of SSH keys and account names that should be able to log in.
 
-Arguments:
+Arguments: none.
 
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
+The response has the same format as the response to the "logins method":#logins above.
 
 h2. list
 
@@ -72,16 +84,6 @@ table(table table-bordered table-condensed).
 |order|string|Order in which to return matching virtual_machines.|query||
 |filters|array|Conditions for filtering virtual_machines.|query||
 
-h2. logins
-
-logins virtual_machines
-
-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
-
 h2. update
 
 Update attributes of an existing VirtualMachine.