Class: ForemanApi::Resources::Role

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

Constant Summary

Constants inherited from Base

Base::API_VERSION

Instance Attribute Summary

Attributes inherited from Base

#client, #config, #logger

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 ForemanApi::Base

Class Method Details

.doc ⇒ Object 



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

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

Instance Method Details

#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):

  • role (Hash, nil) —

    allowed keys are:

    • name [String]

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



34
35
36
 
# File 'lib/foreman_api/resources/role.rb', line 34

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 (String)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



55
56
57
 
# File 'lib/foreman_api/resources/role.rb', line 55

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):

  • page (String) —

    paginate results

  • per_page (String) —

    number of entries per request

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



14
15
16
 
# File 'lib/foreman_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 (String)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



23
24
25
 
# File 'lib/foreman_api/resources/role.rb', line 23

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 (String)
  • role (Hash, nil) —

    allowed keys are:

    • name [String]

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



46
47
48
 
# File 'lib/foreman_api/resources/role.rb', line 46

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