foreman_api 0.0.10 → 0.0.11

data/lib/foreman_api/resources/config_template.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class ConfigTemplate < Apipie::Client::Base
+    class ConfigTemplate < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["config_templates"]
       end
-
+      
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["search", "order", "page", "per_page"]
+      # @option params [String] order Sort results 
+      # @option params [String] page Paginate results 
+      # @option params [String] per_page Number of entries per request 
+      # @option params [String] search Filter results 
       #
       # @param [Hash] headers additional http headers
       def index(params = { }, headers = { })
@@ -16,7 +19,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def show(params = { }, headers = { })
@@ -26,7 +29,15 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"config_template"=>["name", "template", "snippet", "audit_comment", "template_kind_id", "template_combinations_attributes", "operatingsystem_ids"]}
+      # @option params [Hash] config_template 
+      #   allowed keys are: 
+      #   * audit_comment [String, nil],
+      #   * name [String] Template name ,
+      #   * operatingsystem_ids [String] Array of operating systems id to associate the template with ,
+      #   * snippet [String, nil],
+      #   * template [String],
+      #   * template_combinations_attributes [String] Array of template combinations (hostgroupid, environmentid) ,
+      #   * template_kind_id [String, nil] Not relevant for snippet ,
       #
       # @param [Hash] headers additional http headers
       def create(params = { }, headers = { })
@@ -36,7 +47,16 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"id"=>nil, "config_template"=>["name", "template", "snippet", "audit_comment", "template_kind_id", "template_combinations_attributes", "operatingsystem_ids"]}
+      # @option params [String] id 
+      # @option params [Hash] config_template 
+      #   allowed keys are: 
+      #   * audit_comment [String, nil],
+      #   * name [String] Template name ,
+      #   * operatingsystem_ids [String] Array of operating systems id to associate the template with ,
+      #   * snippet [String],
+      #   * template [String],
+      #   * template_combinations_attributes [String] Array of template combinations (hostgroupid, environmentid) ,
+      #   * template_kind_id [String, nil] Not relevant for snippet ,
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })
@@ -46,7 +66,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["version"]
+      # @option params [String] version Template version 
       #
       # @param [Hash] headers additional http headers
       def revision(params = { }, headers = { })
@@ -56,7 +76,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def destroy(params = { }, headers = { })
@@ -66,7 +86,6 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: []
       #
       # @param [Hash] headers additional http headers
       def build_pxe_default(params = { }, headers = { })

data/lib/foreman_api/resources/dashboard.rb

@@ -1,12 +1,12 @@
 module ForemanApi
   module Resources
-    class Dashboard < Apipie::Client::Base
+    class Dashboard < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["dashboard"]
       end
-
+      
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["search"]
+      # @option params [String] search Filter results 
       #
       # @param [Hash] headers additional http headers
       def index(params = { }, headers = { })

data/lib/foreman_api/resources/domain.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class Domain < Apipie::Client::Base
+    class Domain < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["domains"]
       end
-
+      
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["search", "order", "page", "per_page"]
+      # @option params [String] order Sort results 
+      # @option params [String] page Paginate results 
+      # @option params [String] per_page Number of entries per request 
+      # @option params [String] search Filter results 
       #
       # @param [Hash] headers additional http headers
       def index(params = { }, headers = { })
@@ -16,7 +19,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id May be numerical id or domain name 
       #
       # @param [Hash] headers additional http headers
       def show(params = { }, headers = { })
@@ -26,7 +29,12 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"domain"=>["name", "fullname", "dns_id", "domain_parameters_attributes"]}
+      # @option params [Hash] domain 
+      #   allowed keys are: 
+      #   * dns_id [String, nil] Dns proxy to use within this domain ,
+      #   * domain_parameters_attributes [String] Array of parameters (name, value) ,
+      #   * fullname [String, nil] Full name describing the domain ,
+      #   * name [String] The full dns domain name ,
       #
       # @param [Hash] headers additional http headers
       def create(params = { }, headers = { })
@@ -36,7 +44,13 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"id"=>nil, "domain"=>["name", "fullname", "dns_id", "domain_parameters_attributes"]}
+      # @option params [String] id 
+      # @option params [Hash] domain 
+      #   allowed keys are: 
+      #   * dns_id [String, nil] Dns proxy to use within this domain ,
+      #   * domain_parameters_attributes [String] Array of parameters (name, value) ,
+      #   * fullname [String, nil] Full name describing the domain ,
+      #   * name [String, nil] The full dns domain name ,
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })
@@ -46,7 +60,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def destroy(params = { }, headers = { })

data/lib/foreman_api/resources/environment.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class Environment < Apipie::Client::Base
+    class Environment < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["environments"]
       end
-
+      
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["search", "order", "page", "per_page"]
+      # @option params [String] order Sort results 
+      # @option params [String] page Paginate results 
+      # @option params [String] per_page Number of entries per request 
+      # @option params [String] search Filter results 
       #
       # @param [Hash] headers additional http headers
       def index(params = { }, headers = { })
@@ -16,7 +19,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def show(params = { }, headers = { })
@@ -26,7 +29,9 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"environment"=>["name"]}
+      # @option params [Hash] environment 
+      #   allowed keys are: 
+      #   * name [String],
       #
       # @param [Hash] headers additional http headers
       def create(params = { }, headers = { })
@@ -36,7 +41,10 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"id"=>nil, "environment"=>["name"]}
+      # @option params [String] id 
+      # @option params [Hash] environment 
+      #   allowed keys are: 
+      #   * name [String],
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })
@@ -46,7 +54,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def destroy(params = { }, headers = { })

data/lib/foreman_api/resources/fact_value.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class FactValue < Apipie::Client::Base
+    class FactValue < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["fact_values"]
       end
-
+      
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["search", "order", "page", "per_page"]
+      # @option params [String] order Sort results 
+      # @option params [String] page Paginate results 
+      # @option params [String] per_page Number of entries per request 
+      # @option params [String] search Filter results 
       #
       # @param [Hash] headers additional http headers
       def index(params = { }, headers = { })

data/lib/foreman_api/resources/home.rb

@@ -1,12 +1,11 @@
 module ForemanApi
   module Resources
-    class Home < Apipie::Client::Base
+    class Home < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["home"]
       end
-
+      
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: []
       #
       # @param [Hash] headers additional http headers
       def index(params = { }, headers = { })
@@ -16,7 +15,6 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: []
       #
       # @param [Hash] headers additional http headers
       def status(params = { }, headers = { })

data/lib/foreman_api/resources/host.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class Host < Apipie::Client::Base
+    class Host < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["hosts"]
       end
-
+      
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["search", "order", "page", "per_page"]
+      # @option params [String] order Sort results 
+      # @option params [String] page Paginate results 
+      # @option params [String] per_page Number of entries per request 
+      # @option params [String] search Filter results 
       #
       # @param [Hash] headers additional http headers
       def index(params = { }, headers = { })
@@ -16,7 +19,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def show(params = { }, headers = { })
@@ -26,7 +29,26 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"host"=>["name", "environment_id", "ip", "mac", "architecture_id", "domain_id", "puppet_proxy_id", "operatingsystem_id", "medium_id", "ptable_id", "subnet_id", "sp_subnet_id", "model_id_id", "hostgroup_id", "owner_id", "puppet_ca_proxy_id", "image_id", "host_parameters_attributes"]}
+      # @option params [Hash] host 
+      #   allowed keys are: 
+      #   * architecture_id [String],
+      #   * domain_id [String],
+      #   * environment_id [String],
+      #   * host_parameters_attributes [String],
+      #   * hostgroup_id [String],
+      #   * image_id [String],
+      #   * ip [String] Not required if using a subnet with dhcp proxy ,
+      #   * mac [String] Not required if its a virtual machine ,
+      #   * medium_id [String],
+      #   * model_id_id [String],
+      #   * name [String],
+      #   * operatingsystem_id [String],
+      #   * owner_id [String],
+      #   * ptable_id [String],
+      #   * puppet_ca_proxy_id [String],
+      #   * puppet_proxy_id [String],
+      #   * sp_subnet_id [String],
+      #   * subnet_id [String],
       #
       # @param [Hash] headers additional http headers
       def create(params = { }, headers = { })
@@ -36,7 +58,27 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"id"=>nil, "host"=>["name", "environment_id", "ip", "mac", "architecture_id", "domain_id", "puppet_proxy_id", "operatingsystem_id", "medium_id", "ptable_id", "subnet_id", "sp_subnet_id", "model_id_id", "hostgroup_id", "owner_id", "puppet_ca_proxy_id", "image_id", "host_parameters_attributes"]}
+      # @option params [String] id 
+      # @option params [Hash] host 
+      #   allowed keys are: 
+      #   * architecture_id [String],
+      #   * domain_id [String],
+      #   * environment_id [String],
+      #   * host_parameters_attributes [String],
+      #   * hostgroup_id [String],
+      #   * image_id [String],
+      #   * ip [String] Not required if using a subnet with dhcp proxy ,
+      #   * mac [String] Not required if its a virtual machine ,
+      #   * medium_id [String],
+      #   * model_id_id [String],
+      #   * name [String],
+      #   * operatingsystem_id [String],
+      #   * owner_id [String],
+      #   * ptable_id [String],
+      #   * puppet_ca_proxy_id [String],
+      #   * puppet_proxy_id [String],
+      #   * sp_subnet_id [String],
+      #   * subnet_id [String],
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })
@@ -46,7 +88,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def destroy(params = { }, headers = { })
@@ -56,7 +98,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def status(params = { }, headers = { })

data/lib/foreman_api/resources/hostgroup.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class Hostgroup < Apipie::Client::Base
+    class Hostgroup < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["hostgroups"]
       end
-
+      
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["search", "order", "page", "per_page"]
+      # @option params [String] order Sort results 
+      # @option params [String] page Paginate results 
+      # @option params [String] per_page Number of entries per request 
+      # @option params [String] search Filter results 
       #
       # @param [Hash] headers additional http headers
       def index(params = { }, headers = { })
@@ -16,7 +19,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def show(params = { }, headers = { })
@@ -26,7 +29,18 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"hostgroup"=>["name", "environment_id", "operatingsystem_id", "architecture_id", "medium_id", "ptable_id", "puppet_ca_proxy_id", "subnet_id", "domain_id", "puppet_proxy_id"]}
+      # @option params [Hash] hostgroup 
+      #   allowed keys are: 
+      #   * architecture_id [String],
+      #   * domain_id [String],
+      #   * environment_id [String],
+      #   * medium_id [String],
+      #   * name [String],
+      #   * operatingsystem_id [String],
+      #   * ptable_id [String],
+      #   * puppet_ca_proxy_id [String],
+      #   * puppet_proxy_id [String],
+      #   * subnet_id [String],
       #
       # @param [Hash] headers additional http headers
       def create(params = { }, headers = { })
@@ -36,7 +50,19 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"id"=>nil, "hostgroup"=>["name", "environment_id", "operatingsystem_id", "architecture_id", "medium_id", "ptable_id", "puppet_ca_proxy_id", "subnet_id", "domain_id", "puppet_proxy_id"]}
+      # @option params [String] id 
+      # @option params [Hash] hostgroup 
+      #   allowed keys are: 
+      #   * architecture_id [String],
+      #   * domain_id [String],
+      #   * environment_id [String],
+      #   * medium_id [String],
+      #   * name [String],
+      #   * operatingsystem_id [String],
+      #   * ptable_id [String],
+      #   * puppet_ca_proxy_id [String],
+      #   * puppet_proxy_id [String],
+      #   * subnet_id [String],
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })
@@ -46,7 +72,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def destroy(params = { }, headers = { })

data/lib/foreman_api/resources/image.rb

@@ -1,12 +1,16 @@
 module ForemanApi
   module Resources
-    class Image < Apipie::Client::Base
+    class Image < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["images"]
       end
-
+      
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["search", "order", "page", "per_page", "compute_resource_id"]
+      # @option params [String] compute_resource_id 
+      # @option params [String] order Sort results 
+      # @option params [String] page Paginate results 
+      # @option params [String] per_page Number of entries per request 
+      # @option params [String] search Filter results 
       #
       # @param [Hash] headers additional http headers
       def index(params = { }, headers = { })
@@ -16,7 +20,8 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id", "compute_resource_id"]
+      # @option params [String] id 
+      # @option params [String] compute_resource_id 
       #
       # @param [Hash] headers additional http headers
       def show(params = { }, headers = { })
@@ -26,7 +31,15 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"compute_resource_id"=>nil, "image"=>["name", "username", "uuid", "compute_resource_id", "architecture_id", "operatingsystem_id"]}
+      # @option params [String] compute_resource_id 
+      # @option params [Hash] image 
+      #   allowed keys are: 
+      #   * architecture_id [String],
+      #   * compute_resource_id [String],
+      #   * name [String],
+      #   * operatingsystem_id [String],
+      #   * username [String],
+      #   * uuid [String],
       #
       # @param [Hash] headers additional http headers
       def create(params = { }, headers = { })
@@ -36,7 +49,16 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"id"=>nil, "compute_resource_id"=>nil, "image"=>["name", "username", "uuid", "compute_resource_id", "architecture_id", "operatingsystem_id"]}
+      # @option params [String] id 
+      # @option params [String] compute_resource_id 
+      # @option params [Hash] image 
+      #   allowed keys are: 
+      #   * architecture_id [String],
+      #   * compute_resource_id [String],
+      #   * name [String],
+      #   * operatingsystem_id [String],
+      #   * username [String],
+      #   * uuid [String],
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })
@@ -46,7 +68,8 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["compute_resource_id", "id"]
+      # @option params [String] id 
+      # @option params [String] compute_resource_id 
       #
       # @param [Hash] headers additional http headers
       def destroy(params = { }, headers = { })

data/lib/foreman_api/resources/lookup_key.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class LookupKey < Apipie::Client::Base
+    class LookupKey < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["lookup_keys"]
       end
-
+      
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["search", "order", "page", "per_page"]
+      # @option params [String] order Sort results 
+      # @option params [String] page Paginate results 
+      # @option params [String] per_page Number of entries per request 
+      # @option params [String] search Filter results 
       #
       # @param [Hash] headers additional http headers
       def index(params = { }, headers = { })
@@ -16,7 +19,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def show(params = { }, headers = { })
@@ -26,7 +29,14 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"lookup_key"=>["key", "puppetclass_id", "default_value", "path", "description", "lookup_values_count"]}
+      # @option params [Hash] lookup_key 
+      #   allowed keys are: 
+      #   * default_value [String],
+      #   * description [String],
+      #   * key [String],
+      #   * lookup_values_count [String],
+      #   * path [String],
+      #   * puppetclass_id [String],
       #
       # @param [Hash] headers additional http headers
       def create(params = { }, headers = { })
@@ -36,7 +46,15 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"id"=>nil, "lookup_key"=>["key", "puppetclass_id", "default_value", "path", "description", "lookup_values_count"]}
+      # @option params [String] id 
+      # @option params [Hash] lookup_key 
+      #   allowed keys are: 
+      #   * default_value [String],
+      #   * description [String],
+      #   * key [String],
+      #   * lookup_values_count [String],
+      #   * path [String],
+      #   * puppetclass_id [String],
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })
@@ -46,7 +64,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def destroy(params = { }, headers = { })

data/lib/foreman_api/resources/medium.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class Medium < Apipie::Client::Base
+    class Medium < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["media"]
       end
-
+      
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["search", "order", "page", "per_page"]
+      # @option params [String] order For example, name asc, or name desc 
+      # @option params [String] page Paginate results 
+      # @option params [String] per_page Number of entries per request 
+      # @option params [String] search Filter results 
       #
       # @param [Hash] headers additional http headers
       def index(params = { }, headers = { })
@@ -16,7 +19,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def show(params = { }, headers = { })
@@ -26,7 +29,11 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"medium"=>["name", "path", "os_family"]}
+      # @option params [Hash] medium 
+      #   allowed keys are: 
+      #   * name [String] Name of media ,
+      #   * os_family [String] The family that the operating system belongs to.  available families:   archlinux debian redhat solaris suse windows  ,
+      #   * path [String] The path to the medium, can be a url or a valid nfs server (exclusive of the architecture).  for example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host&#39;s actual os architecture and $version, $major and $minor will be substituted for the version of the operating system.  solaris and debian media may also use $release. ,
       #
       # @param [Hash] headers additional http headers
       def create(params = { }, headers = { })
@@ -36,7 +43,12 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"medium"=>["name", "path", "os_family"], "id"=>nil}
+      # @option params [String] id 
+      # @option params [Hash] medium 
+      #   allowed keys are: 
+      #   * name [String] Name of media ,
+      #   * os_family [String, nil] The family that the operating system belongs to.  available families:   archlinux debian redhat solaris suse windows  ,
+      #   * path [String] The path to the medium, can be a url or a valid nfs server (exclusive of the architecture).  for example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host&#39;s actual os architecture and $version, $major and $minor will be substituted for the version of the operating system.  solaris and debian media may also use $release. ,
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })
@@ -46,7 +58,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id"]
+      # @option params [String] id 
       #
       # @param [Hash] headers additional http headers
       def destroy(params = { }, headers = { })