From bd4f4f05c9831549b91c4f4843066bc25d34a0f6 Mon Sep 17 00:00:00 2001 From: Wesley Beary Date: Mon, 12 Oct 2009 09:25:33 -0700 Subject: [PATCH] fill in docs for rackspace stuff --- lib/fog/rackspace/requests/files/get_containers.rb | 9 ++++++--- lib/fog/rackspace/requests/servers/get_flavors.rb | 6 ++++-- lib/fog/rackspace/requests/servers/get_images.rb | 7 +++++-- lib/fog/rackspace/requests/servers/get_servers.rb | 14 ++++++++++++-- 4 files changed, 27 insertions(+), 9 deletions(-) diff --git a/lib/fog/rackspace/requests/files/get_containers.rb b/lib/fog/rackspace/requests/files/get_containers.rb index 8fee479b5..9007b136a 100644 --- a/lib/fog/rackspace/requests/files/get_containers.rb +++ b/lib/fog/rackspace/requests/files/get_containers.rb @@ -10,11 +10,14 @@ unless Fog.mocking? # * options<~Hash>: # * 'limit'<~Integer> - Upper limit to number of results returned # * 'marker'<~String> - Only return objects with name greater than this value + # # ==== Returns # * response<~Fog::AWS::Response>: - # * body<~Hash>: - # * 'publicIp'<~String> - The acquired address - # * 'requestId'<~String> - Id of the request + # * body<~Array>: + # * container<~Hash>: + # * 'bytes'<~Integer>: - Number of bytes used by container + # * 'count'<~Integer>: - Number of items in container + # * 'name'<~String>: - Name of container def get_containers(options = {}) options = { 'format' => 'json' }.merge!(options) query = [] diff --git a/lib/fog/rackspace/requests/servers/get_flavors.rb b/lib/fog/rackspace/requests/servers/get_flavors.rb index 525ec3041..a069b6d22 100644 --- a/lib/fog/rackspace/requests/servers/get_flavors.rb +++ b/lib/fog/rackspace/requests/servers/get_flavors.rb @@ -9,8 +9,10 @@ unless Fog.mocking? # ==== Returns # * response<~Fog::AWS::Response>: # * body<~Hash>: - # * 'publicIp'<~String> - The acquired address - # * 'requestId'<~String> - Id of the request + # * 'id'<~Integer> - Id of the flavor + # * 'name'<~String> - Name of the flavor + # * 'ram'<~Integer> - Amount of ram for the flavor + # * 'disk'<~Integer> - Amount of diskspace for the flavor def get_flavors request( :method => 'GET', diff --git a/lib/fog/rackspace/requests/servers/get_images.rb b/lib/fog/rackspace/requests/servers/get_images.rb index ad7157bbf..d65eabc9f 100644 --- a/lib/fog/rackspace/requests/servers/get_images.rb +++ b/lib/fog/rackspace/requests/servers/get_images.rb @@ -9,8 +9,11 @@ unless Fog.mocking? # ==== Returns # * response<~Fog::AWS::Response>: # * body<~Hash>: - # * 'publicIp'<~String> - The acquired address - # * 'requestId'<~String> - Id of the request + # * 'id'<~Integer> - Id of the image + # * 'name'<~String> - Name of the image + # * 'updated'<~String> - Last update timestamp for image + # * 'created'<~String> - Creation timestamp for image + # * 'status'<~String> - Status of image def get_images request( :method => 'GET', diff --git a/lib/fog/rackspace/requests/servers/get_servers.rb b/lib/fog/rackspace/requests/servers/get_servers.rb index a2efa391c..6f34d72c7 100644 --- a/lib/fog/rackspace/requests/servers/get_servers.rb +++ b/lib/fog/rackspace/requests/servers/get_servers.rb @@ -9,8 +9,18 @@ unless Fog.mocking? # ==== Returns # * response<~Fog::AWS::Response>: # * body<~Hash>: - # * 'publicIp'<~String> - The acquired address - # * 'requestId'<~String> - Id of the request + # * 'servers'<~Array>: + # * 'id'<~Integer> - Id of server + # * 'name<~String> - Name of server + # * 'imageId'<~Integer> - Id of image used to boot server + # * 'flavorId'<~Integer> - Id of servers current flavor + # * 'hostId'<~String> + # * 'status'<~String> - Current server status + # * 'progress'<~Integer> - Progress through current status + # * 'addresses'<~Hash>: + # * 'public'<~Array> - public address strings + # * 'private'<~Array> - private address strings + # * 'metadata'<~Hash> - metadata def get_servers request( :method => 'GET',