Class: Devdraft::APIHealthApi

Inherits:
Object
  • Object
show all
Defined in:
lib/devdraft/api/api_health_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ APIHealthApi

Returns a new instance of APIHealthApi.



19
20
21
 
# File 'lib/devdraft/api/api_health_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/devdraft/api/api_health_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#health_controller_check_v0(opts = {}) ⇒ HealthResponseDto

Authenticated health check endpoint

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/devdraft/api/api_health_api.rb', line 25

def health_controller_check_v0(opts = {})
  data, _status_code, _headers = health_controller_check_v0_with_http_info(opts)
  data
end

#health_controller_check_v0_with_http_info(opts = {}) ⇒ Array<(HealthResponseDto, Integer, Hash)>

Authenticated health check endpoint

Parameters:

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

    the optional parameters

Returns:

  • (Array<(HealthResponseDto, Integer, Hash)>) —

    HealthResponseDto data, response status code and response headers



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/devdraft/api/api_health_api.rb', line 33

def health_controller_check_v0_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIHealthApi.health_controller_check_v0 ...'
  end
  # resource path
  local_var_path = '/api/v0/health'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'HealthResponseDto'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['x-client-secret', 'x-client-key']

  new_options = opts.merge(
    :operation => :"APIHealthApi.health_controller_check_v0",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: APIHealthApi#health_controller_check_v0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#health_controller_public_health_check_v0(opts = {}) ⇒ PublicHealthResponseDto

Public health check endpoint

Parameters:

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/devdraft/api/api_health_api.rb', line 80

def health_controller_public_health_check_v0(opts = {})
  data, _status_code, _headers = health_controller_public_health_check_v0_with_http_info(opts)
  data
end

#health_controller_public_health_check_v0_with_http_info(opts = {}) ⇒ Array<(PublicHealthResponseDto, Integer, Hash)>

Public health check endpoint

Parameters:

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

    the optional parameters

Returns:

  • (Array<(PublicHealthResponseDto, Integer, Hash)>) —

    PublicHealthResponseDto data, response status code and response headers



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/devdraft/api/api_health_api.rb', line 88

def health_controller_public_health_check_v0_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIHealthApi.health_controller_public_health_check_v0 ...'
  end
  # resource path
  local_var_path = '/api/v0/health/public'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PublicHealthResponseDto'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"APIHealthApi.health_controller_public_health_check_v0",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: APIHealthApi#health_controller_public_health_check_v0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end