katello_api 0.0.3 → 0.0.4

data/lib/katello_api/resources/provider.rb

@@ -7,7 +7,15 @@ module KatelloApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] organization_id  organization identifier 
-      # @option params [String] name  filter providers by name 
+      # @option params [String] order  sort field and order, eg. ‘name desc’ 
+      # @option params [String] page  page number, starting at 1 
+      # @option params [String] per_page  number of results per page to return 
+      # @option params [String] provider_type  filter providers by type (‘custom’ or ‘red hat’) 
+      # @option params [String] search  search string 
+      # @option params [Hash] sort  hash version of ‘order’ param 
+      #   allowed keys are:
+      #   * by [String]  field to sort the results on 
+      #   * order [String]  how to order the sorted results (e.g. asc for ascending) 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -26,12 +34,9 @@ module KatelloApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] organization_id  organization identifier 
-      # @option params [Hash] provider
-      #   allowed keys are:
-      #   * description [String, nil]  provider description 
-      #   * name [String]  provider name 
-      #   * provider_type [String]
-      #   * repository_url [String, nil]  repository url 
+      # @option params [String] description  description of the provider 
+      # @option params [String] name  name of the provider 
+      # @option params [String] provider_type  the type of the provider 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -40,12 +45,8 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id  provider numeric identifier 
-      # @option params [Hash] provider
-      #   allowed keys are:
-      #   * description [String, nil]  provider description 
-      #   * name [String]  provider name 
-      #   * repository_url [String, nil]  repository url 
+      # @option params [String] id  provider identifier 
+      # @option params [String] repository_url  provider repository url 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -64,6 +65,7 @@ module KatelloApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id  provider numeric identifier 
+      # @option params [String] include_marketing  include marketing products in results 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -72,23 +74,22 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Object] id Part of +/api/providers/:id/discovery+ path
-      # @option params [String] url  remote url to perform discovery 
+      # @option params [String] id  provider numeric identifier 
+      # @option params [String] force  force import 
+      # @option params [String] import  manifest file 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
-      def discovery(params = {}, headers = {})
+      def import_manifest(params = {}, headers = {})
         perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id  provider numeric identifier 
-      # @option params [String] force  force import 
-      # @option params [String] import  manifest file 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
-      def import_manifest(params = {}, headers = {})
+      def refresh_manifest(params = {}, headers = {})
         perform_call(__method__, params, headers)
       end
 
@@ -112,7 +113,7 @@ module KatelloApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id  provider numeric identifier 
-      # @option params [String] products  array of products to import 
+      # @option params [Array] products  array of products to import 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/katello_api/resources/puppet_module.rb

@@ -0,0 +1,39 @@
+module KatelloApi
+  module Resources
+    class PuppetModule < KatelloApi::Base
+      def self.doc
+        @doc ||= KatelloApi.doc['resources']["puppet_modules"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] repository_id  repository numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def index(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] repository_id  repository numeric identifier 
+      # @option params [String] search  search expression 
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def search(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  puppet module id 
+      # @option params [String] repository_id  repository numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def show(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+    end
+  end
+end

data/lib/katello_api/resources/repository.rb

@@ -6,9 +6,32 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] organization_id  id of an organization the repository will be contained in 
-      # @option params [String] product_id  id of a product the repository will be contained in 
+      # @option params [String] environment_id  id of an environment to show repositories in 
+      # @option params [String] organization_id  id of an organization to show repositories in 
+      # @option params [String] product_id  id of a product to show repositories of 
+      # @option params [String] enabled  limit to only enabled repositories 
+      # @option params [String] library  show repositories in library and the default content view 
+      # @option params [String] order  sort field and order, eg. ‘name desc’ 
+      # @option params [String] page  page number, starting at 1 
+      # @option params [String] per_page  number of results per page to return 
+      # @option params [String] search  search string 
+      # @option params [Hash] sort  hash version of ‘order’ param 
+      #   allowed keys are:
+      #   * by [String]  field to sort the results on 
+      #   * order [String]  how to order the sorted results (e.g. asc for ascending) 
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def index(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] product_id  product the repository belongs to 
+      # @option params [String] content_type  type of repo (either ‘yum’ or ‘puppet’, defaults to ‘yum’) 
+      # @option params [String] enabled  flag that enables/disables the repository 
       # @option params [String] gpg_key_name  name of a gpg key that will be assigned to the new repository 
+      # @option params [String] label
       # @option params [String] name
       # @option params [String] url  repository source url 
       #
@@ -29,9 +52,7 @@ module KatelloApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id  repository id 
-      # @option params [Hash] repository
-      #   allowed keys are:
-      #   * gpg_key_name [String]  name of a gpg key that will be assigned to the repository 
+      # @option params [String] gpg_key_id  id of a gpg key that will be assigned to this repository 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -49,66 +70,11 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id
-      # @option params [String] enable  flag that enables/disables the repository 
-      #
-      # @param [Hash] headers additional http headers
-      # @return [Array] First item: parsed data; second item: raw body
-      def enable(params = {}, headers = {})
-        perform_call(__method__, params, headers)
-      end
-
-      # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id
-      #
-      # @param [Hash] headers additional http headers
-      # @return [Array] First item: parsed data; second item: raw body
-      def sync_complete(params = {}, headers = {})
-        perform_call(__method__, params, headers)
-      end
-
-      # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id
-      #
-      # @param [Hash] headers additional http headers
-      # @return [Array] First item: parsed data; second item: raw body
-      def package_groups(params = {}, headers = {})
-        perform_call(__method__, params, headers)
-      end
-
-      # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id
-      #
-      # @param [Hash] headers additional http headers
-      # @return [Array] First item: parsed data; second item: raw body
-      def package_group_categories(params = {}, headers = {})
-        perform_call(__method__, params, headers)
-      end
-
-      # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id
-      #
-      # @param [Hash] headers additional http headers
-      # @return [Array] First item: parsed data; second item: raw body
-      def gpg_key_content(params = {}, headers = {})
-        perform_call(__method__, params, headers)
-      end
-
-      # @param [Hash] params a hash of params to be passed to the service
-      #
-      # @param [Hash] headers additional http headers
-      # @return [Array] First item: parsed data; second item: raw body
-      def list_content_view_definition_repositories(params = {}, headers = {})
-        perform_call(__method__, params, headers)
-      end
-
-      # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] content_view_definition_id  content view definition identifier 
-      # @option params [String] repos  updated list of repo ids 
+      # @option params [String] id  repository id 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
-      def update_content_view_definition_repositories(params = {}, headers = {})
+      def sync(params = {}, headers = {})
         perform_call(__method__, params, headers)
       end
 

data/lib/katello_api/resources/repository_set.rb

@@ -28,8 +28,7 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] organization_id  id of an 
-      # @option params [String] product_id  id of a product to list repository sets in 
+      # @option params [String] product_id  id of a product to list repository sets for 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/katello_api/resources/role.rb

@@ -6,7 +6,6 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Object] user_id Part of +/api/users/:user_id/roles+ path
       # @option params [String] name
       #
       # @param [Hash] headers additional http headers
@@ -17,7 +16,6 @@ module KatelloApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [Object] id Part of +/api/roles/:id+ path
-      # @option params [Object] user_id Part of +/api/users/:user_id/roles/:id+ path
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -26,7 +24,6 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Object] user_id Part of +/api/users/:user_id/roles+ path
       # @option params [Hash] role
       #   allowed keys are:
       #   * description [String, nil]
@@ -40,7 +37,6 @@ module KatelloApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [Object] id Part of +/api/roles/:id+ path
-      # @option params [Object] user_id Part of +/api/users/:user_id/roles/:id+ path
       # @option params [Hash] role
       #   allowed keys are:
       #   * description [String, nil]
@@ -54,7 +50,6 @@ module KatelloApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [Object] id Part of +/api/roles/:id+ path
-      # @option params [Object] user_id Part of +/api/users/:user_id/roles/:id+ path
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/katello_api/resources/role_ldap_group.rb

@@ -7,7 +7,9 @@ module KatelloApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [Object] role_id Part of +/api/roles/:role_id/ldap_groups+ path
-      # @option params [String] name  name of the ldap group 
+      # @option params [Hash] ldap_group
+      #   allowed keys are:
+      #   * name [String]  name of the ldap group 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/katello_api/resources/status.rb

@@ -0,0 +1,18 @@
+module KatelloApi
+  module Resources
+    class Status < KatelloApi::Base
+      def self.doc
+        @doc ||= KatelloApi.doc['resources']["status"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def memory(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+    end
+  end
+end

data/lib/katello_api/resources/subscription.rb

@@ -6,7 +6,8 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] system_id  system uuid 
+      # @option params [String] organization_id  organization id 
+      # @option params [String] system_id  uuid of the system 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -15,9 +16,34 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  subscription identifier 
+      # @option params [String] organization_id  organization identifier 
       # @option params [String] system_id  system uuid 
-      # @option params [String] pool  subscription pool uuid 
-      # @option params [String] quantity  number of subscription to use 
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def show(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] system_id  uuid of the system 
+      # @option params [String] match_installed  return subscriptions that match installed 
+      # @option params [String] match_system  return subscriptions that match system 
+      # @option params [String] no_overlap  return subscriptions that don’t overlap 
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def available(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] system_id  uuid of the system 
+      # @option params [Hash] subscription
+      #   allowed keys are:
+      #   * pool [String]  subscription pool uuid 
+      #   * quantity [String]  number of subscription to use 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -27,7 +53,7 @@ module KatelloApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id  entitlement id 
-      # @option params [String] system_id  system uuid 
+      # @option params [String] system_id  uuid of the system 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -36,7 +62,7 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] system_id  system uuid 
+      # @option params [String] system_id  uuid of the system 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -45,12 +71,12 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] serial_id  subscription serial id 
+      # @option params [String] organization_id  organization id 
       # @option params [String] system_id  system uuid 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
-      def destroy_by_serial(params = {}, headers = {})
+      def upload(params = {}, headers = {})
         perform_call(__method__, params, headers)
       end
 

data/lib/katello_api/resources/sync.rb

@@ -6,10 +6,9 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] organization_id  oranization identifier 
-      # @option params [String] product_id  product identifier 
-      # @option params [String] provider_id  provider identifier 
-      # @option params [String] repository_id  repository identifier 
+      # @option params [Object] product_id Part of +/api/products/:product_id/sync+ path
+      # @option params [Object] provider_id Part of +/api/providers/:provider_id/sync+ path
+      # @option params [Object] repository_id Part of +/api/repositories/:repository_id/sync+ path
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -18,10 +17,9 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] organization_id  oranization identifier 
-      # @option params [String] product_id  product identifier 
-      # @option params [String] provider_id  provider identifier 
-      # @option params [String] repository_id  repository identifier 
+      # @option params [Object] product_id Part of +/api/products/:product_id/sync+ path
+      # @option params [Object] provider_id Part of +/api/providers/:provider_id/sync+ path
+      # @option params [Object] repository_id Part of +/api/repositories/:repository_id/sync+ path
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -30,10 +28,9 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] organization_id  oranization identifier 
-      # @option params [String] product_id  product identifier 
-      # @option params [String] provider_id  provider identifier 
-      # @option params [String] repository_id  repository identifier 
+      # @option params [Object] product_id Part of +/api/products/:product_id/sync+ path
+      # @option params [Object] provider_id Part of +/api/providers/:provider_id/sync+ path
+      # @option params [Object] repository_id Part of +/api/repositories/:repository_id/sync+ path
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/katello_api/resources/sync_plan.rb

@@ -6,7 +6,7 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] organization_id  oranization identifier 
+      # @option params [Object] organization_id Part of +/api/organizations/:organization_id/sync_plans+ path
       # @option params [String] interval  filter by interval 
       # @option params [String] name  filter by name 
       # @option params [String] sync_date  filter by sync date 
@@ -19,7 +19,6 @@ module KatelloApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id  sync plan numeric identifier 
-      # @option params [String] organization_id  oranization identifier 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -28,7 +27,7 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] organization_id  oranization identifier 
+      # @option params [Object] organization_id Part of +/api/organizations/:organization_id/sync_plans+ path
       # @option params [Hash] sync_plan
       #   allowed keys are:
       #   * description [String, nil]  sync plan description 
@@ -44,7 +43,6 @@ module KatelloApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id  sync plan numeric identifier 
-      # @option params [String] organization_id  oranization identifier 
       # @option params [Hash] sync_plan
       #   allowed keys are:
       #   * description [String, nil]  sync plan description 
@@ -60,7 +58,6 @@ module KatelloApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id  sync plan numeric identifier 
-      # @option params [String] organization_id  oranization identifier 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body