lib/fog/brightbox/requests/compute/get_account.rb in fog-1.7.0 vs lib/fog/brightbox/requests/compute/get_account.rb in fog-1.8.0
- old
+ new
@@ -1,27 +1,19 @@
module Fog
module Compute
class Brightbox
class Real
- # Requests details about an account from the API
+ # Get full details of the account.
#
- # === Parameters:
+ # @overload get_account(identifier)
+ # @param [String] identifier Unique reference to identify the resource
#
- # <tt>identifier <String></tt>:: The identifier to request (Default is +nil+)
+ # @overload get_account()
+ # @deprecated Use {Fog::Compute::Brightbox::Real#get_scoped_account} instead
#
- # === Returns:
+ # @return [Hash] The JSON response parsed to a Hash
#
- # <tt>Hash</tt>:: The JSON response parsed to a Hash
- #
- # === Notes:
- #
- # This also supports a deprecated form where if an identifier is not
- # passed then the scoping account is returned instead. This should not
- # be used in new code. Use #get_scoped_account instead.
- #
- # === Reference:
- #
- # https://api.gb1.brightbox.com/1.0/#account_get_account
+ # @see https://api.gb1.brightbox.com/1.0/#account_get_account
#
def get_account(identifier = nil)
if identifier.nil? || identifier.empty?
Fog::Logger.deprecation("get_account() without a parameter is deprecated, use get_scoped_account instead [light_black](#{caller.first})[/]")
get_scoped_account