Class: KatelloApi::Resources::Role

Inherits:
Base
  • Object
show all
Defined in:
lib/katello_api/resources/role.rb

Constant Summary

Constants inherited from Base

Base::API_VERSION

Instance Attribute Summary

Attributes inherited from Base

#client, #config

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#http_call, #initialize, method_doc, #perform_call, #validate_params!, validation_hash

Constructor Details

This class inherits a constructor from KatelloApi::Base

Class Method Details

.doc ⇒ Object 



4
5
6
 
# File 'lib/katello_api/resources/role.rb', line 4

def self.doc
  @doc ||= KatelloApi.doc['resources']["roles"]
end

Instance Method Details

#available_verbs(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • organization_id (String) —

    with this option specified the listed tags are scoped to the organization.

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



70
71
72
 
# File 'lib/katello_api/resources/role.rb', line 70

def available_verbs(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#create(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • user_id (Object) —

    Part of /api/users/:user_id/roles path

  • role (Hash) —

    allowed keys are:

    • description [String, nil]

    • name [String]

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



37
38
39
 
# File 'lib/katello_api/resources/role.rb', line 37

def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#destroy(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (Object) —

    Part of /api/roles/:id path

  • user_id (Object) —

    Part of /api/users/:user_id/roles/:id path

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



61
62
63
 
# File 'lib/katello_api/resources/role.rb', line 61

def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#index(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • user_id (Object) —

    Part of /api/users/:user_id/roles path

  • name (String)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



14
15
16
 
# File 'lib/katello_api/resources/role.rb', line 14

def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#show(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (Object) —

    Part of /api/roles/:id path

  • user_id (Object) —

    Part of /api/users/:user_id/roles/:id path

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



24
25
26
 
# File 'lib/katello_api/resources/role.rb', line 24

def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#update(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (Object) —

    Part of /api/roles/:id path

  • user_id (Object) —

    Part of /api/users/:user_id/roles/:id path

  • role (Hash) —

    allowed keys are:

    • description [String, nil]

    • name [String]

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



51
52
53
 
# File 'lib/katello_api/resources/role.rb', line 51

def update(params = {}, headers = {})
  perform_call(__method__, params, headers)
end