1
0
Fork 0
mirror of https://github.com/fog/fog.git synced 2022-11-09 13:51:43 -05:00

[Brightbox] Documentation fixes

Fixes yardoc for request methods.
This commit is contained in:
Paul Thornthwaite 2013-05-14 12:02:24 +01:00
parent c3e4d7eddf
commit ab0ac9dfad
75 changed files with 135 additions and 83 deletions

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#server_activate_console_server # @see https://api.gb1.brightbox.com/1.0/#server_activate_console_server
# #

View file

@ -8,7 +8,8 @@ module Fog
# @param [Hash] options # @param [Hash] options
# @option options [Array] :listeners Array of Listener parameters. Timeout is optional and specified in milliseconds. # @option options [Array] :listeners Array of Listener parameters. Timeout is optional and specified in milliseconds.
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#load_balancer_add_listeners_load_balancer # @see https://api.gb1.brightbox.com/1.0/#load_balancer_add_listeners_load_balancer
# #

View file

@ -8,7 +8,8 @@ module Fog
# @param [Hash] options # @param [Hash] options
# @option options [Array] :nodes Array of Node parameters # @option options [Array] :nodes Array of Node parameters
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#load_balancer_add_nodes_load_balancer # @see https://api.gb1.brightbox.com/1.0/#load_balancer_add_nodes_load_balancer
# #

View file

@ -6,14 +6,22 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# @param [Hash] options # @param [Hash] options
# @option options [Array<Hash>] :servers Array of Hashes containing `{"server" => server_id}` for each server to add # @option options [Array<Hash>] :servers Array of Hashes containing
# +{"server" => server_id}+ for each server to add
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#server_group_add_servers_server_group # @see https://api.gb1.brightbox.com/1.0/#server_group_add_servers_server_group
# #
# @example # @example
# Compute[:brightbox].add_servers_server_group "grp-12345", :servers => [{"server" => "srv-abcde"}, {"server" => "srv-fghij"}] # options = {
# :servers => [
# {"server" => "srv-abcde"},
# {"server" => "srv-fghij"}
# ]
# }
# Compute[:brightbox].add_servers_server_group "grp-12345", options
# #
def add_servers_server_group(identifier, options) def add_servers_server_group(identifier, options)
return nil if identifier.nil? || identifier == "" return nil if identifier.nil? || identifier == ""

View file

@ -8,7 +8,8 @@ module Fog
# @param [Hash] options # @param [Hash] options
# @option options [String] :server_group Server Group to apply to # @option options [String] :server_group Server Group to apply to
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#firewall_policy_apply_to_firewall_policy # @see https://api.gb1.brightbox.com/1.0/#firewall_policy_apply_to_firewall_policy
# #

View file

@ -8,7 +8,8 @@ module Fog
# @option options [String] :name # @option options [String] :name
# @option options [String] :description # @option options [String] :description
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#api_client_create_api_client # @see https://api.gb1.brightbox.com/1.0/#api_client_create_api_client
# #

View file

@ -8,7 +8,8 @@ module Fog
# @option options [String] :name # @option options [String] :name
# @option options [String] :description # @option options [String] :description
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#application_create_application # @see https://api.gb1.brightbox.com/1.0/#application_create_application
# #

View file

@ -9,7 +9,8 @@ module Fog
# @option options [String] :name Name for Cloud IP # @option options [String] :name Name for Cloud IP
# @option options [Array] :port_translators Port on which external clients connect and port on which your service is listening. # @option options [Array] :port_translators Port on which external clients connect and port on which your service is listening.
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#cloud_ip_create_cloud_ip # @see https://api.gb1.brightbox.com/1.0/#cloud_ip_create_cloud_ip
# #

View file

@ -11,7 +11,8 @@ module Fog
# @option options [String] :name Editable label # @option options [String] :name Editable label
# @option options [String] :description Longer editable description # @option options [String] :description Longer editable description
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#firewall_policy_create_firewall_policy # @see https://api.gb1.brightbox.com/1.0/#firewall_policy_create_firewall_policy
# #

View file

@ -14,7 +14,8 @@ module Fog
# @option options [String] :icmp_type_name # @option options [String] :icmp_type_name
# @option options [String] :description # @option options [String] :description
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#firewall_rule_create_firewall_rule # @see https://api.gb1.brightbox.com/1.0/#firewall_rule_create_firewall_rule
# #

View file

@ -15,7 +15,8 @@ module Fog
# @option options [Boolean] :compatibility_mode # @option options [Boolean] :compatibility_mode
# @option options [String] :description # @option options [String] :description
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#image_create_image # @see https://api.gb1.brightbox.com/1.0/#image_create_image
# #

View file

@ -11,7 +11,8 @@ module Fog
# @option options [Array] :listeners What port to listen on, port to pass through to and protocol (tcp, http or http+ws) of listener. Timeout is optional and specified in milliseconds (default is 50000). # @option options [Array] :listeners What port to listen on, port to pass through to and protocol (tcp, http or http+ws) of listener. Timeout is optional and specified in milliseconds (default is 50000).
# @option options [String] :healthcheck Healthcheck options - only "port" and "type" required # @option options [String] :healthcheck Healthcheck options - only "port" and "type" required
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#load_balancer_create_load_balancer # @see https://api.gb1.brightbox.com/1.0/#load_balancer_create_load_balancer
# #

View file

@ -14,7 +14,8 @@ module Fog
# @option options [String] :user_data # @option options [String] :user_data
# @option options [Array] :server_groups Array of server groups to add server to # @option options [Array] :server_groups Array of server groups to add server to
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#server_create_server # @see https://api.gb1.brightbox.com/1.0/#server_create_server
# #

View file

@ -8,7 +8,8 @@ module Fog
# @option options [String] :name Editable user label # @option options [String] :name Editable user label
# @option options [String] :description Editable user description # @option options [String] :description Editable user description
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#server_group_create_server_group # @see https://api.gb1.brightbox.com/1.0/#server_group_create_server_group
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#api_client_delete_api_client # @see https://api.gb1.brightbox.com/1.0/#api_client_delete_api_client
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#application_delete_application # @see https://api.gb1.brightbox.com/1.0/#application_delete_application
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#cloud_ip_delete_cloud_ip # @see https://api.gb1.brightbox.com/1.0/#cloud_ip_delete_cloud_ip
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#firewall_policy_delete_firewall_policy # @see https://api.gb1.brightbox.com/1.0/#firewall_policy_delete_firewall_policy
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#firewall_rule_delete_firewall_rule # @see https://api.gb1.brightbox.com/1.0/#firewall_rule_delete_firewall_rule
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#image_delete_image # @see https://api.gb1.brightbox.com/1.0/#image_delete_image
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#load_balancer_delete_load_balancer # @see https://api.gb1.brightbox.com/1.0/#load_balancer_delete_load_balancer
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#server_delete_server # @see https://api.gb1.brightbox.com/1.0/#server_delete_server
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#server_group_delete_server_group # @see https://api.gb1.brightbox.com/1.0/#server_group_delete_server_group
# #

View file

@ -10,7 +10,7 @@ module Fog
# @overload get_account() # @overload get_account()
# @deprecated Use {Fog::Compute::Brightbox::Real#get_scoped_account} instead # @deprecated Use {Fog::Compute::Brightbox::Real#get_scoped_account} instead
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#account_get_account # @see https://api.gb1.brightbox.com/1.0/#account_get_account
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#api_client_get_api_client # @see https://api.gb1.brightbox.com/1.0/#api_client_get_api_client
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#application_get_application # @see https://api.gb1.brightbox.com/1.0/#application_get_application
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#cloud_ip_get_cloud_ip # @see https://api.gb1.brightbox.com/1.0/#cloud_ip_get_cloud_ip
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#firewall_policy_get_firewall_policy # @see https://api.gb1.brightbox.com/1.0/#firewall_policy_get_firewall_policy
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#firewall_rule_get_firewall_rule # @see https://api.gb1.brightbox.com/1.0/#firewall_rule_get_firewall_rule
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#image_get_image # @see https://api.gb1.brightbox.com/1.0/#image_get_image
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#interface_get_interface # @see https://api.gb1.brightbox.com/1.0/#interface_get_interface
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#load_balancer_get_load_balancer # @see https://api.gb1.brightbox.com/1.0/#load_balancer_get_load_balancer
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#server_get_server # @see https://api.gb1.brightbox.com/1.0/#server_get_server
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#server_group_get_server_group # @see https://api.gb1.brightbox.com/1.0/#server_group_get_server_group
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#server_type_get_server_type # @see https://api.gb1.brightbox.com/1.0/#server_type_get_server_type
# #

View file

@ -10,7 +10,7 @@ module Fog
# @overload get_user() # @overload get_user()
# @deprecated Use {Fog::Compute::Brightbox::Real#get_authenticated_user} instead # @deprecated Use {Fog::Compute::Brightbox::Real#get_authenticated_user} instead
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#user_get_user # @see https://api.gb1.brightbox.com/1.0/#user_get_user
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#zone_get_zone # @see https://api.gb1.brightbox.com/1.0/#zone_get_zone
# #

View file

@ -3,7 +3,7 @@ module Fog
class Brightbox class Brightbox
class Real class Real
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#account_list_accounts # @see https://api.gb1.brightbox.com/1.0/#account_list_accounts
# #

View file

@ -5,7 +5,7 @@ module Fog
# Lists summary details of API clients owned by the account. # Lists summary details of API clients owned by the account.
# #
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#api_client_list_api_clients # @see https://api.gb1.brightbox.com/1.0/#api_client_list_api_clients
# #

View file

@ -5,7 +5,7 @@ module Fog
# Lists summary details of applications available to the user # Lists summary details of applications available to the user
# #
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#application_list_applications # @see https://api.gb1.brightbox.com/1.0/#application_list_applications
# #

View file

@ -5,7 +5,7 @@ module Fog
# Lists summary details of cloud IP addresses owned by the account. # Lists summary details of cloud IP addresses owned by the account.
# #
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#cloud_ip_list_cloud_ips # @see https://api.gb1.brightbox.com/1.0/#cloud_ip_list_cloud_ips
# #

View file

@ -5,7 +5,7 @@ module Fog
# Lists summary details of firewall policies # Lists summary details of firewall policies
# #
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#firewall_policy_list_firewall_policies # @see https://api.gb1.brightbox.com/1.0/#firewall_policy_list_firewall_policies
# #

View file

@ -5,7 +5,7 @@ module Fog
# Lists summary details of images available for use by the Account. It includes those available to all customers # Lists summary details of images available for use by the Account. It includes those available to all customers
# #
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#image_list_images # @see https://api.gb1.brightbox.com/1.0/#image_list_images
# #

View file

@ -5,7 +5,7 @@ module Fog
# Lists summary details of load balancers owned by the account. # Lists summary details of load balancers owned by the account.
# #
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#load_balancer_list_load_balancers # @see https://api.gb1.brightbox.com/1.0/#load_balancer_list_load_balancers
# #

View file

@ -5,7 +5,7 @@ module Fog
# Lists summary details of server groups owned by the account. # Lists summary details of server groups owned by the account.
# #
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#server_group_list_server_groups # @see https://api.gb1.brightbox.com/1.0/#server_group_list_server_groups
# #

View file

@ -5,7 +5,7 @@ module Fog
# Lists summary details of server types available to the account. # Lists summary details of server types available to the account.
# #
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#server_type_list_server_types # @see https://api.gb1.brightbox.com/1.0/#server_type_list_server_types
# #

View file

@ -5,7 +5,7 @@ module Fog
# Lists summary details of servers owned by the account. # Lists summary details of servers owned by the account.
# #
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#server_list_servers # @see https://api.gb1.brightbox.com/1.0/#server_list_servers
# #

View file

@ -5,7 +5,7 @@ module Fog
# Lists summary details of user. # Lists summary details of user.
# #
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#user_list_users # @see https://api.gb1.brightbox.com/1.0/#user_list_users
# #

View file

@ -5,7 +5,7 @@ module Fog
# Lists summary details of zones available to the account. # Lists summary details of zones available to the account.
# #
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#zone_list_zones # @see https://api.gb1.brightbox.com/1.0/#zone_list_zones
# #

View file

@ -8,7 +8,8 @@ module Fog
# @param [Hash] options # @param [Hash] options
# @option options [String] :destination The ID of an Interface or LoadBalancer to map the Cloud IP against # @option options [String] :destination The ID of an Interface or LoadBalancer to map the Cloud IP against
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#cloud_ip_map_cloud_ip # @see https://api.gb1.brightbox.com/1.0/#cloud_ip_map_cloud_ip
# #

View file

@ -6,15 +6,24 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# @param [Hash] options # @param [Hash] options
# @option options [Array<Hash>] :servers Array of Hashes containing `{"server" => server_id}` for each server to remove # @option options [Array<Hash>] :servers Array of Hashes containing
# +{"server" => server_id}+ for each server to remove
# @option options [String] :destination ServerGroup to move servers to # @option options [String] :destination ServerGroup to move servers to
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#server_group_move_servers_server_group # @see https://api.gb1.brightbox.com/1.0/#server_group_move_servers_server_group
# #
# @example # @example
# Compute[:brightbox].remove_servers_server_group "grp-12345", :destination => "grp-67890", :servers => [{"server" => "srv-abcde"}, {"server" => "srv-fghij"}] # options = {
# :destination => "grp-67890",
# :servers => [
# {"server" => "srv-abcde"},
# {"server" => "srv-fghij"}
# ]
# }
# Compute[:brightbox].remove_servers_server_group "grp-12345", options
# #
def move_servers_server_group(identifier, options) def move_servers_server_group(identifier, options)
return nil if identifier.nil? || identifier == "" return nil if identifier.nil? || identifier == ""

View file

@ -8,7 +8,8 @@ module Fog
# @param [Hash] options # @param [Hash] options
# @option options [String] :server_group Server Group to remove # @option options [String] :server_group Server Group to remove
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#firewall_policy_remove_firewall_policy # @see https://api.gb1.brightbox.com/1.0/#firewall_policy_remove_firewall_policy
# #

View file

@ -8,7 +8,8 @@ module Fog
# @param [Hash] options # @param [Hash] options
# @option options [Array] :listeners Array of Listener parameters # @option options [Array] :listeners Array of Listener parameters
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#load_balancer_remove_listeners_load_balancer # @see https://api.gb1.brightbox.com/1.0/#load_balancer_remove_listeners_load_balancer
# #

View file

@ -8,7 +8,8 @@ module Fog
# @param [Hash] options # @param [Hash] options
# @option options [Array] :nodes Array of Node parameters # @option options [Array] :nodes Array of Node parameters
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#load_balancer_remove_nodes_load_balancer # @see https://api.gb1.brightbox.com/1.0/#load_balancer_remove_nodes_load_balancer
# #

View file

@ -6,14 +6,22 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# @param [Hash] options # @param [Hash] options
# @option options [Array<Hash>] :servers Array of Hashes containing {"server" => server_id} for each server # @option options [Array<Hash>] :servers Array of Hashes containing
# +{"server" => server_id}+ for each server
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#server_group_remove_servers_server_group # @see https://api.gb1.brightbox.com/1.0/#server_group_remove_servers_server_group
# #
# @example # @example
# Compute[:brightbox].remove_servers_server_group "grp-12345", :servers => [{"server" => "srv-abcde"}, {"server" => "srv-fghij"}] # options = {
# :servers => [
# {"server" => "srv-abcde"},
# {"server" => "srv-fghij"}
# ]
# }
# Compute[:brightbox].remove_servers_server_group "grp-12345", options
# #
def remove_servers_server_group(identifier, options) def remove_servers_server_group(identifier, options)
return nil if identifier.nil? || identifier == "" return nil if identifier.nil? || identifier == ""

View file

@ -11,9 +11,9 @@ module Fog
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @overload reset_ftp_password_account() # @overload reset_ftp_password_account()
# @deprecated Use {Fog::Compute::Brightbox::Real#get_scoped_account} instead # @deprecated Use {Fog::Compute::Brightbox::Real#reset_ftp_password_scoped_account} instead
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#account_reset_ftp_password_account # @see https://api.gb1.brightbox.com/1.0/#account_reset_ftp_password_account
# #

View file

@ -2,7 +2,6 @@ module Fog
module Compute module Compute
class Brightbox class Brightbox
class Real class Real
# Resets the secret used by the API client to a new generated value. # Resets the secret used by the API client to a new generated value.
# #
# The response is the only time the new secret is available in plaintext. # The response is the only time the new secret is available in plaintext.
@ -11,7 +10,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#api_client_reset_secret_api_client # @see https://api.gb1.brightbox.com/1.0/#api_client_reset_secret_api_client
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#application_reset_secret_application # @see https://api.gb1.brightbox.com/1.0/#application_reset_secret_application
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#server_shutdown_server # @see https://api.gb1.brightbox.com/1.0/#server_shutdown_server
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#server_snapshot_server # @see https://api.gb1.brightbox.com/1.0/#server_snapshot_server
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#server_start_server # @see https://api.gb1.brightbox.com/1.0/#server_start_server
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#server_stop_server # @see https://api.gb1.brightbox.com/1.0/#server_stop_server
# #

View file

@ -6,7 +6,7 @@ module Fog
# #
# @param [String] identifier Unique reference to identify the resource # @param [String] identifier Unique reference to identify the resource
# #
# @return [Hash] The JSON response parsed to a Hash # @return [Hash] if successful Hash version of JSON object
# #
# @see https://api.gb1.brightbox.com/1.0/#cloud_ip_unmap_cloud_ip # @see https://api.gb1.brightbox.com/1.0/#cloud_ip_unmap_cloud_ip
# #

View file

@ -31,7 +31,8 @@ module Fog
# @option options [String] :vat_registration_number Must be a valid EU VAT number or `nil` # @option options [String] :vat_registration_number Must be a valid EU VAT number or `nil`
# @option options [String] :telephone_number Valid International telephone number in E.164 format prefixed with `+` # @option options [String] :telephone_number Valid International telephone number in E.164 format prefixed with `+`
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#account_update_account # @see https://api.gb1.brightbox.com/1.0/#account_update_account
# #

View file

@ -9,7 +9,8 @@ module Fog
# @option options [String] :name # @option options [String] :name
# @option options [String] :description # @option options [String] :description
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#api_client_update_api_client # @see https://api.gb1.brightbox.com/1.0/#api_client_update_api_client
# #

View file

@ -9,7 +9,8 @@ module Fog
# @option options [String] :name # @option options [String] :name
# @option options [String] :description # @option options [String] :description
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#application_update_application # @see https://api.gb1.brightbox.com/1.0/#application_update_application
# #

View file

@ -10,7 +10,8 @@ module Fog
# @option options [String] :name Name for Cloud IP # @option options [String] :name Name for Cloud IP
# @option options [Array] :port_translators Port on which external clients connect and port on which your service is listening. # @option options [Array] :port_translators Port on which external clients connect and port on which your service is listening.
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#cloud_ip_update_cloud_ip # @see https://api.gb1.brightbox.com/1.0/#cloud_ip_update_cloud_ip
# #

View file

@ -9,7 +9,8 @@ module Fog
# @option options [String] :name Editable label # @option options [String] :name Editable label
# @option options [String] :description Longer editable description # @option options [String] :description Longer editable description
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#firewall_policy_update_firewall_policy # @see https://api.gb1.brightbox.com/1.0/#firewall_policy_update_firewall_policy
# #

View file

@ -14,7 +14,8 @@ module Fog
# @option options [String] :icmp_type_name # @option options [String] :icmp_type_name
# @option options [String] :description # @option options [String] :description
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#firewall_rule_update_firewall_rule # @see https://api.gb1.brightbox.com/1.0/#firewall_rule_update_firewall_rule
# #

View file

@ -14,7 +14,8 @@ module Fog
# @option options [Boolean] :compatibility_mode # @option options [Boolean] :compatibility_mode
# @option options [String] :description # @option options [String] :description
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#image_update_image # @see https://api.gb1.brightbox.com/1.0/#image_update_image
# #

View file

@ -12,7 +12,8 @@ module Fog
# @option options [Array] :listeners What port to listen on, port to pass through to and protocol (tcp, http or http+ws) of listener. Timeout is optional and specified in milliseconds (default is 50000). # @option options [Array] :listeners What port to listen on, port to pass through to and protocol (tcp, http or http+ws) of listener. Timeout is optional and specified in milliseconds (default is 50000).
# @option options [String] :healthcheck Healthcheck options - only "port" and "type" required # @option options [String] :healthcheck Healthcheck options - only "port" and "type" required
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#load_balancer_update_load_balancer # @see https://api.gb1.brightbox.com/1.0/#load_balancer_update_load_balancer
# #

View file

@ -15,7 +15,8 @@ module Fog
# @option options [String] :vat_registration_number Must be a valid EU VAT number or `nil` # @option options [String] :vat_registration_number Must be a valid EU VAT number or `nil`
# @option options [String] :telephone_number Valid International telephone number in E.164 format prefixed with `+` # @option options [String] :telephone_number Valid International telephone number in E.164 format prefixed with `+`
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#account_update_account # @see https://api.gb1.brightbox.com/1.0/#account_update_account
# #

View file

@ -10,7 +10,8 @@ module Fog
# @option options [String] :user_data User defined metadata # @option options [String] :user_data User defined metadata
# @option options [Boolean] :compatibility_mode Server needs to be shutdown and restarted for changes to this to take effect # @option options [Boolean] :compatibility_mode Server needs to be shutdown and restarted for changes to this to take effect
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#server_update_server # @see https://api.gb1.brightbox.com/1.0/#server_update_server
# #

View file

@ -9,7 +9,8 @@ module Fog
# @option options [String] :name Editable user label # @option options [String] :name Editable user label
# @option options [String] :description Editable user description # @option options [String] :description Editable user description
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#server_group_update_server_group # @see https://api.gb1.brightbox.com/1.0/#server_group_update_server_group
# #

View file

@ -12,7 +12,8 @@ module Fog
# @option options [String] :password A password string that conforms to the minimum requirements # @option options [String] :password A password string that conforms to the minimum requirements
# @option options [String] :password_confirmation A password string that conforms to the minimum requirements # @option options [String] :password_confirmation A password string that conforms to the minimum requirements
# #
# @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed # @return [Hash] if successful Hash version of JSON object
# @return [NilClass] if no options were passed
# #
# @see https://api.gb1.brightbox.com/1.0/#user_update_user # @see https://api.gb1.brightbox.com/1.0/#user_update_user
# #