foreman_api 0.0.10 → 0.0.11

data/lib/foreman_api/resources/model.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class Model < Apipie::Client::Base
+    class Model < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["models"]
       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,12 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"model"=>["name", "info", "vendor_class", "hardware_model"]}
+      # @option params [Hash] model 
+      #   allowed keys are: 
+      #   * hardware_model [String],
+      #   * info [String],
+      #   * name [String],
+      #   * vendor_class [String],
       #
       # @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: {"model"=>["name", "info", "vendor_class", "hardware_model"], "id"=>nil}
+      # @option params [String] id 
+      # @option params [Hash] model 
+      #   allowed keys are: 
+      #   * hardware_model [String],
+      #   * info [String],
+      #   * name [String],
+      #   * vendor_class [String],
       #
       # @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/operating_system.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class OperatingSystem < Apipie::Client::Base
+    class OperatingSystem < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["operatingsystems"]
       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,13 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"operatingsystem"=>["name", "major", "minor", "family", "release_name"]}
+      # @option params [Hash] operatingsystem 
+      #   allowed keys are: 
+      #   * family [String],
+      #   * major [String],
+      #   * minor [String],
+      #   * name [String],
+      #   * release_name [String],
       #
       # @param [Hash] headers additional http headers
       def create(params = { }, headers = { })
@@ -36,7 +45,14 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"operatingsystem"=>["name", "major", "minor", "family", "release_name"], "id"=>nil}
+      # @option params [String] id 
+      # @option params [Hash] operatingsystem 
+      #   allowed keys are: 
+      #   * family [String],
+      #   * major [String],
+      #   * minor [String],
+      #   * name [String],
+      #   * release_name [String],
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })
@@ -46,7 +62,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 +72,9 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["id", "medium", "architecture"]
+      # @option params [String] id 
+      # @option params [String] architecture 
+      # @option params [String] medium 
       #
       # @param [Hash] headers additional http headers
       def bootfiles(params = { }, headers = { })

data/lib/foreman_api/resources/ptable.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class Ptable < Apipie::Client::Base
+    class Ptable < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["ptables"]
       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,11 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"ptable"=>["name", "layout", "os_family"]}
+      # @option params [Hash] ptable 
+      #   allowed keys are: 
+      #   * layout [String],
+      #   * name [String],
+      #   * os_family [String],
       #
       # @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: {"id"=>nil, "ptable"=>["name", "layout", "os_family"]}
+      # @option params [String] id 
+      # @option params [Hash] ptable 
+      #   allowed keys are: 
+      #   * layout [String],
+      #   * name [String],
+      #   * os_family [String],
       #
       # @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 = { })

data/lib/foreman_api/resources/puppetclass.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class Puppetclass < Apipie::Client::Base
+    class Puppetclass < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["puppetclasses"]
       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: {"puppetclass"=>["name"]}
+      # @option params [Hash] puppetclass 
+      #   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: {"puppetclass"=>["name"], "id"=>nil}
+      # @option params [String] id 
+      # @option params [Hash] puppetclass 
+      #   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/report.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class Report < Apipie::Client::Base
+    class Report < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["reports"]
       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,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/role.rb

@@ -1,12 +1,13 @@
 module ForemanApi
   module Resources
-    class Role < Apipie::Client::Base
+    class Role < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["roles"]
       end
-
+      
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["page", "per_page"]
+      # @option params [String] page Paginate results 
+      # @option params [String] per_page Number of entries per request 
       #
       # @param [Hash] headers additional http headers
       def index(params = { }, headers = { })
@@ -16,7 +17,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 +27,9 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"role"=>["name"]}
+      # @option params [Hash] role 
+      #   allowed keys are: 
+      #   * name [String],
       #
       # @param [Hash] headers additional http headers
       def create(params = { }, headers = { })
@@ -36,7 +39,10 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"role"=>["name"], "id"=>nil}
+      # @option params [String] id 
+      # @option params [Hash] role 
+      #   allowed keys are: 
+      #   * name [String],
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })
@@ -46,7 +52,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/setting.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class Setting < Apipie::Client::Base
+    class Setting < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["settings"]
       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,10 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"id"=>nil, "setting"=>["value"]}
+      # @option params [String] id 
+      # @option params [Hash] setting 
+      #   allowed keys are: 
+      #   * value [String],
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })

data/lib/foreman_api/resources/smart_proxy.rb

@@ -1,12 +1,14 @@
 module ForemanApi
   module Resources
-    class SmartProxy < Apipie::Client::Base
+    class SmartProxy < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["smart_proxies"]
       end
-
+      
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: ["type", "page", "per_page"]
+      # @option params [String] page Paginate results 
+      # @option params [String] per_page Number of entries per request 
+      # @option params [String] type Filter by type 
       #
       # @param [Hash] headers additional http headers
       def index(params = { }, headers = { })
@@ -16,7 +18,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 +28,10 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"smart_proxy"=>["name", "url"]}
+      # @option params [Hash] smart_proxy 
+      #   allowed keys are: 
+      #   * name [String],
+      #   * url [String],
       #
       # @param [Hash] headers additional http headers
       def create(params = { }, headers = { })
@@ -36,7 +41,11 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"smart_proxy"=>["name", "url"], "id"=>nil}
+      # @option params [String] id 
+      # @option params [Hash] smart_proxy 
+      #   allowed keys are: 
+      #   * name [String],
+      #   * url [String],
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })
@@ -46,7 +55,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/subnet.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class Subnet < Apipie::Client::Base
+    class Subnet < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["subnets"]
       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,21 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"subnet"=>["name", "network", "mask", "gateway", "dns_primary", "dns_secondary", "from", "to", "vlanid", "domain_ids", "dhcp_id", "tftp_id", "dns_id"]}
+      # @option params [Hash] subnet 
+      #   allowed keys are: 
+      #   * dhcp_id [String] Dhcp proxy to use within this subnet ,
+      #   * dns_id [String] Dns proxy to use within this subnet ,
+      #   * dns_primary [String] Primary dns for this subnet ,
+      #   * dns_secondary [String] Secondary dns for this subnet ,
+      #   * domain_ids [String] Domains in which this subnet is part ,
+      #   * from [String] Starting ip address for ip auto suggestion ,
+      #   * gateway [String] Primary dns for this subnet ,
+      #   * mask [String] Netmask for this subnet ,
+      #   * name [String] Subnet name ,
+      #   * network [String] Subnet network ,
+      #   * tftp_id [String] Tftp proxy to use within this subnet ,
+      #   * to [String] Ending ip address for ip auto suggestion ,
+      #   * vlanid [String] Vlan id for this subnet ,
       #
       # @param [Hash] headers additional http headers
       def create(params = { }, headers = { })
@@ -36,7 +53,22 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"id"=>nil, "subnet"=>["name", "network", "mask", "gateway", "dns_primary", "dns_secondary", "from", "to", "vlanid", "domain_ids", "dhcp_id", "tftp_id", "dns_id"]}
+      # @option params [String] id Subnet numeric identifier 
+      # @option params [Hash] subnet 
+      #   allowed keys are: 
+      #   * dhcp_id [String, nil] Dhcp proxy to use within this subnet ,
+      #   * dns_id [String, nil] Dns proxy to use within this subnet ,
+      #   * dns_primary [String, nil] Primary dns for this subnet ,
+      #   * dns_secondary [String, nil] Secondary dns for this subnet ,
+      #   * domain_ids [String, nil] Domains in which this subnet is part ,
+      #   * from [String, nil] Starting ip address for ip auto suggestion ,
+      #   * gateway [String, nil] Primary dns for this subnet ,
+      #   * mask [String] Netmask for this subnet ,
+      #   * name [String] Subnet name ,
+      #   * network [String] Subnet network ,
+      #   * tftp_id [String, nil] Tftp proxy to use within this subnet ,
+      #   * to [String, nil] Ending ip address for ip auto suggestion ,
+      #   * vlanid [String, nil] Vlan id for this subnet ,
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })
@@ -46,7 +78,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 Subnet numeric identifier 
       #
       # @param [Hash] headers additional http headers
       def destroy(params = { }, headers = { })

data/lib/foreman_api/resources/template_kind.rb

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

data/lib/foreman_api/resources/user.rb

@@ -1,12 +1,15 @@
 module ForemanApi
   module Resources
-    class User < Apipie::Client::Base
+    class User < ForemanApi::Base
       def self.doc
         @doc ||= ForemanApi.doc['resources']["users"]
       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: {"user"=>["login", "firstname", "lastname", "mail", "admin", "password", "auth_source_id"]}
+      # @option params [Hash] user 
+      #   allowed keys are: 
+      #   * admin [String] Is an admin account? ,
+      #   * auth_source_id [Numeric],
+      #   * firstname [String],
+      #   * lastname [String],
+      #   * login [String],
+      #   * mail [String],
+      #   * password [String],
       #
       # @param [Hash] headers additional http headers
       def create(params = { }, headers = { })
@@ -36,7 +47,15 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # allowed keys are: {"id"=>nil, "user"=>["login", "firstname", "lastname", "mail", "admin", "password"]}
+      # @option params [String] id 
+      # @option params [Hash] user 
+      #   allowed keys are: 
+      #   * admin [String] Is an admin account? ,
+      #   * firstname [String, nil],
+      #   * lastname [String, nil],
+      #   * login [String],
+      #   * mail [String],
+      #   * password [String],
       #
       # @param [Hash] headers additional http headers
       def update(params = { }, headers = { })
@@ -46,7 +65,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 = { })