Class: ForemanApi::Resources::Home

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

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) doc



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

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

Instance Method Details

- (Object) index(params = { }, headers = { })

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers



11
12
13
14
15
# File 'lib/foreman_api/resources/home.rb', line 11

def index(params = { }, headers = { })
  check_params params, :allowed => false, :method => __method__
  url, params = fill_params_in_url "/api", params
  call(:get", url, params, headers)
end

- (Object) status(params = { }, headers = { })

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers



20
21
22
23
24
# File 'lib/foreman_api/resources/home.rb', line 20

def status(params = { }, headers = { })
  check_params params, :allowed => false, :method => __method__
  url, params = fill_params_in_url "/api/status", params
  call(:get", url, params, headers)
end