class SwaggerClient::PingApi
Attributes
api_client[RW]
Public Class Methods
new(api_client = ApiClient.default)
click to toggle source
# File lib/harbor_swagger_client/api/ping_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
ping_get(opts = {})
click to toggle source
Ping Harbor to check if it's alive. This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components. @param [Hash] opts the optional parameters @return [String]
# File lib/harbor_swagger_client/api/ping_api.rb, line 26 def ping_get(opts = {}) data, _status_code, _headers = ping_get_with_http_info(opts) data end
ping_get_with_http_info(opts = {})
click to toggle source
Ping Harbor to check if it's alive. This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components. @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
# File lib/harbor_swagger_client/api/ping_api.rb, line 35 def ping_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PingApi.ping_get ...' end # resource path local_var_path = '/ping' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['text/plain']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['basic'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: PingApi#ping_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end