class FCP::APIApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/first-class-postcodes/api/api_api.rb, line 7
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_specification(opts = {}) click to toggle source

OpenAPI Specification Retrieve the OpenAPI Specification for this base path. @param [Hash] opts the optional parameters @return [Object]

# File lib/first-class-postcodes/api/api_api.rb, line 14
def get_specification(opts = {})
  data, _status_code, _headers = get_specification_with_http_info(opts)
  data
end
get_specification_with_http_info(opts = {}) click to toggle source

OpenAPI Specification Retrieve the OpenAPI Specification for this base path. @param [Hash] opts the optional parameters @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers

# File lib/first-class-postcodes/api/api_api.rb, line 23
def get_specification_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIApi.get_specification ...'
  end
  # resource path
  local_var_path = '/.spec'

  # 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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'Object' 

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

  new_options = opts.merge(
    :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: APIApi#get_specification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end