openapi-generator/samples/client/echo_api/ruby-faraday/docs/HeaderApi.md

OpenapiClient::HeaderApi

All URIs are relative to http://localhost:3000

Method	HTTP request	Description
test_header_integer_boolean_string_enums	GET /header/integer/boolean/string/enums	Test header parameter(s)

test_header_integer_boolean_string_enums

String test_header_integer_boolean_string_enums(opts)

Test header parameter(s)

Test header parameter(s)

Examples

require 'time'
require 'openapi_client'

api_instance = OpenapiClient::HeaderApi.new
opts = {
  integer_header: 56, # Integer | 
  boolean_header: true, # Boolean | 
  string_header: 'string_header_example', # String | 
  enum_nonref_string_header: 'success', # String | 
  enum_ref_string_header: OpenapiClient::StringEnumRef::SUCCESS # StringEnumRef | 
}

begin
  # Test header parameter(s)
  result = api_instance.test_header_integer_boolean_string_enums(opts)
  p result
rescue OpenapiClient::ApiError => e
  puts "Error when calling HeaderApi->test_header_integer_boolean_string_enums: #{e}"
end

Using the test_header_integer_boolean_string_enums_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(String, Integer, Hash)> test_header_integer_boolean_string_enums_with_http_info(opts)

begin
  # Test header parameter(s)
  data, status_code, headers = api_instance.test_header_integer_boolean_string_enums_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => String
rescue OpenapiClient::ApiError => e
  puts "Error when calling HeaderApi->test_header_integer_boolean_string_enums_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
integer_header	Integer		[optional]
boolean_header	Boolean		[optional]
string_header	String		[optional]
enum_nonref_string_header	String		[optional]
enum_ref_string_header	StringEnumRef		[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain