forked from loafle/openapi-generator-original

use map/array model class only if it is generated (#17612 )

* fix

* tests

* generate samples

* refactor

2024-01-29 21:35:21 +08:00

40 KiB

Raw Blame History

Petstore::FakeApi

All URIs are relative to http://petstore.swagger.io:80/v2

Method	HTTP request	Description
fake_big_decimal_map	GET /fake/BigDecimalMap
fake_health_get	GET /fake/health	Health check endpoint
fake_http_signature_test	GET /fake/http-signature-test	test http signature authentication
fake_outer_boolean_serialize	POST /fake/outer/boolean
fake_outer_composite_serialize	POST /fake/outer/composite
fake_outer_number_serialize	POST /fake/outer/number
fake_outer_string_serialize	POST /fake/outer/string
fake_property_enum_integer_serialize	POST /fake/property/enum-int
get_parameter_name_mapping	GET /fake/parameter-name-mapping	parameter name mapping test
test_additional_properties_reference	POST /fake/additionalProperties-reference	test referenced additionalProperties
test_body_with_binary	PUT /fake/body-with-binary
test_body_with_file_schema	PUT /fake/body-with-file-schema
test_body_with_query_params	PUT /fake/body-with-query-params
test_client_model	PATCH /fake	To test "client" model
test_endpoint_parameters	POST /fake	Fake endpoint for testing various parameters 假端點偽のエンドポイント 가짜 엔드 포인트
test_enum_parameters	GET /fake	To test enum parameters
test_group_parameters	DELETE /fake	Fake endpoint to test group parameters (optional)
test_inline_additional_properties	POST /fake/inline-additionalProperties	test inline additionalProperties
test_inline_freeform_additional_properties	POST /fake/inline-freeform-additionalProperties	test inline free-form additionalProperties
test_json_form_data	GET /fake/jsonFormData	test json serialization of form data
test_query_parameter_collection_format	PUT /fake/test-query-parameters
test_string_map_reference	POST /fake/stringMap-reference	test referenced string map

fake_big_decimal_map

fake_big_decimal_map

for Java apache and Java native, test toUrlQueryString for maps with BegDecimal keys

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new

begin
  
  result = api_instance.fake_big_decimal_map
  p result
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_big_decimal_map: #{e}"
end

Using the fake_big_decimal_map_with_http_info variant

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

<Array(, Integer, Hash)> fake_big_decimal_map_with_http_info

begin
  
  data, status_code, headers = api_instance.fake_big_decimal_map_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FakeBigDecimalMap200Response>
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_big_decimal_map_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

FakeBigDecimalMap200Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

fake_health_get

fake_health_get

Health check endpoint

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new

begin
  # Health check endpoint
  result = api_instance.fake_health_get
  p result
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_health_get: #{e}"
end

Using the fake_health_get_with_http_info variant

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

<Array(, Integer, Hash)> fake_health_get_with_http_info

begin
  # Health check endpoint
  data, status_code, headers = api_instance.fake_health_get_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <HealthCheckResult>
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_health_get_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

HealthCheckResult

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

fake_http_signature_test

fake_http_signature_test(pet, opts)

test http signature authentication

Examples

require 'time'
require 'petstore'
# setup authorization
Petstore.configure do |config|
end

api_instance = Petstore::FakeApi.new
pet = Petstore::Pet.new({name: 'doggie', photo_urls: ['photo_urls_example']}) # Pet | Pet object that needs to be added to the store
opts = {
  query_1: 'query_1_example', # String | query parameter
  header_1: 'header_1_example' # String | header parameter
}

begin
  # test http signature authentication
  api_instance.fake_http_signature_test(pet, opts)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_http_signature_test: #{e}"
end

Using the fake_http_signature_test_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> fake_http_signature_test_with_http_info(pet, opts)

begin
  # test http signature authentication
  data, status_code, headers = api_instance.fake_http_signature_test_with_http_info(pet, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_http_signature_test_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pet	Pet	Pet object that needs to be added to the store
query_1	String	query parameter	[optional]
header_1	String	header parameter	[optional]

Return type

nil (empty response body)

Authorization

http_signature_test

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

fake_outer_boolean_serialize

Boolean fake_outer_boolean_serialize(opts)

Test serialization of outer boolean types

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
opts = {
  body: true # Boolean | Input boolean as post body
}

begin
  
  result = api_instance.fake_outer_boolean_serialize(opts)
  p result
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_outer_boolean_serialize: #{e}"
end

Using the fake_outer_boolean_serialize_with_http_info variant

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

<Array(Boolean, Integer, Hash)> fake_outer_boolean_serialize_with_http_info(opts)

begin
  
  data, status_code, headers = api_instance.fake_outer_boolean_serialize_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Boolean
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_outer_boolean_serialize_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	Boolean	Input boolean as post body	[optional]

Return type

Boolean

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

fake_outer_composite_serialize

fake_outer_composite_serialize(opts)

Test serialization of object with outer number type

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
opts = {
  outer_composite: Petstore::OuterComposite.new # OuterComposite | Input composite as post body
}

begin
  
  result = api_instance.fake_outer_composite_serialize(opts)
  p result
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_outer_composite_serialize: #{e}"
end

Using the fake_outer_composite_serialize_with_http_info variant

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

<Array(, Integer, Hash)> fake_outer_composite_serialize_with_http_info(opts)

begin
  
  data, status_code, headers = api_instance.fake_outer_composite_serialize_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OuterComposite>
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_outer_composite_serialize_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
outer_composite	OuterComposite	Input composite as post body	[optional]

Return type

OuterComposite

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

fake_outer_number_serialize

Float fake_outer_number_serialize(opts)

Test serialization of outer number types

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
opts = {
  body: 8.14 # Float | Input number as post body
}

begin
  
  result = api_instance.fake_outer_number_serialize(opts)
  p result
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_outer_number_serialize: #{e}"
end

Using the fake_outer_number_serialize_with_http_info variant

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

<Array(Float, Integer, Hash)> fake_outer_number_serialize_with_http_info(opts)

begin
  
  data, status_code, headers = api_instance.fake_outer_number_serialize_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Float
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_outer_number_serialize_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	Float	Input number as post body	[optional]

Return type

Float

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

fake_outer_string_serialize

String fake_outer_string_serialize(opts)

Test serialization of outer string types

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
opts = {
  body: 'body_example' # String | Input string as post body
}

begin
  
  result = api_instance.fake_outer_string_serialize(opts)
  p result
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_outer_string_serialize: #{e}"
end

Using the fake_outer_string_serialize_with_http_info variant

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

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

begin
  
  data, status_code, headers = api_instance.fake_outer_string_serialize_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => String
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_outer_string_serialize_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	String	Input string as post body	[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

fake_property_enum_integer_serialize

fake_property_enum_integer_serialize(outer_object_with_enum_property)

Test serialization of enum (int) properties with examples

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
outer_object_with_enum_property = Petstore::OuterObjectWithEnumProperty.new({value: Petstore::OuterEnumInteger::N0}) # OuterObjectWithEnumProperty | Input enum (int) as post body

begin
  
  result = api_instance.fake_property_enum_integer_serialize(outer_object_with_enum_property)
  p result
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_property_enum_integer_serialize: #{e}"
end

Using the fake_property_enum_integer_serialize_with_http_info variant

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

<Array(, Integer, Hash)> fake_property_enum_integer_serialize_with_http_info(outer_object_with_enum_property)

begin
  
  data, status_code, headers = api_instance.fake_property_enum_integer_serialize_with_http_info(outer_object_with_enum_property)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OuterObjectWithEnumProperty>
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->fake_property_enum_integer_serialize_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
outer_object_with_enum_property	OuterObjectWithEnumProperty	Input enum (int) as post body

Return type

OuterObjectWithEnumProperty

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

get_parameter_name_mapping

get_parameter_name_mapping(type, type, type, http_debug_option)

parameter name mapping test

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
_type = 789 # Integer | _type
type = 'type_example' # String | type
type_ = 'type__example' # String | type_
http_debug_option = 'http_debug_option_example' # String | http debug option (to test parameter naming option)

begin
  # parameter name mapping test
  api_instance.get_parameter_name_mapping(_type, type, type_, http_debug_option)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->get_parameter_name_mapping: #{e}"
end

Using the get_parameter_name_mapping_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> get_parameter_name_mapping_with_http_info(type, type, type, http_debug_option)

begin
  # parameter name mapping test
  data, status_code, headers = api_instance.get_parameter_name_mapping_with_http_info(_type, type, type_, http_debug_option)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->get_parameter_name_mapping_with_http_info: #{e}"
end

Parameters

Name	Type	Description
_type	Integer	_type
type	String	type
type_	String	type_
http_debug_option	String	http debug option (to test parameter naming option)

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

test_additional_properties_reference

test_additional_properties_reference(request_body)

test referenced additionalProperties

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
request_body = { key: 3.56} # Hash<String, Object> | request body

begin
  # test referenced additionalProperties
  api_instance.test_additional_properties_reference(request_body)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_additional_properties_reference: #{e}"
end

Using the test_additional_properties_reference_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> test_additional_properties_reference_with_http_info(request_body)

begin
  # test referenced additionalProperties
  data, status_code, headers = api_instance.test_additional_properties_reference_with_http_info(request_body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_additional_properties_reference_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
request_body	Hash<String, Object>	request body

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

test_body_with_binary

test_body_with_binary(body)

For this test, the body has to be a binary file.

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
body = File.new('/path/to/some/file') # File | image to upload

begin
  
  api_instance.test_body_with_binary(body)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_body_with_binary: #{e}"
end

Using the test_body_with_binary_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> test_body_with_binary_with_http_info(body)

begin
  
  data, status_code, headers = api_instance.test_body_with_binary_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_body_with_binary_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	File	image to upload

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: image/png
Accept: Not defined

test_body_with_file_schema

test_body_with_file_schema(file_schema_test_class)

For this test, the body for this request must reference a schema named File.

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
file_schema_test_class = Petstore::FileSchemaTestClass.new # FileSchemaTestClass | 

begin
  
  api_instance.test_body_with_file_schema(file_schema_test_class)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_body_with_file_schema: #{e}"
end

Using the test_body_with_file_schema_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> test_body_with_file_schema_with_http_info(file_schema_test_class)

begin
  
  data, status_code, headers = api_instance.test_body_with_file_schema_with_http_info(file_schema_test_class)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_body_with_file_schema_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
file_schema_test_class	FileSchemaTestClass

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

test_body_with_query_params

test_body_with_query_params(query, user)

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
query = 'query_example' # String | 
user = Petstore::User.new # User | 

begin
  
  api_instance.test_body_with_query_params(query, user)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_body_with_query_params: #{e}"
end

Using the test_body_with_query_params_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> test_body_with_query_params_with_http_info(query, user)

begin
  
  data, status_code, headers = api_instance.test_body_with_query_params_with_http_info(query, user)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_body_with_query_params_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
query	String
user	User

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

test_client_model

test_client_model(client)

To test "client" model

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
client = Petstore::Client.new # Client | client model

begin
  # To test \"client\" model
  result = api_instance.test_client_model(client)
  p result
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_client_model: #{e}"
end

Using the test_client_model_with_http_info variant

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

<Array(, Integer, Hash)> test_client_model_with_http_info(client)

begin
  # To test \"client\" model
  data, status_code, headers = api_instance.test_client_model_with_http_info(client)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Client>
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_client_model_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
client	Client	client model

Return type

Client

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

test_endpoint_parameters

test_endpoint_parameters(number, double, pattern_without_delimiter, byte, opts)

Fake endpoint for testing various parameters 假端點偽のエンドポイント 가짜 엔드 포인트

Examples

require 'time'
require 'petstore'
# setup authorization
Petstore.configure do |config|
  # Configure HTTP basic authorization: http_basic_test
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Petstore::FakeApi.new
number = 8.14 # Float | None
double = 1.2 # Float | None
pattern_without_delimiter = 'pattern_without_delimiter_example' # String | None
byte = 'BYTE_ARRAY_DATA_HERE' # String | None
opts = {
  integer: 56, # Integer | None
  int32: 56, # Integer | None
  int64: 789, # Integer | None
  float: 3.4, # Float | None
  string: 'string_example', # String | None
  binary: File.new('/path/to/some/file'), # File | None
  date: Date.parse('2013-10-20'), # Date | None
  date_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | None
  password: 'password_example', # String | None
  callback: 'callback_example' # String | None
}

begin
  # Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 
  api_instance.test_endpoint_parameters(number, double, pattern_without_delimiter, byte, opts)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_endpoint_parameters: #{e}"
end

Using the test_endpoint_parameters_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> test_endpoint_parameters_with_http_info(number, double, pattern_without_delimiter, byte, opts)

begin
  # Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 
  data, status_code, headers = api_instance.test_endpoint_parameters_with_http_info(number, double, pattern_without_delimiter, byte, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_endpoint_parameters_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
number	Float	None
double	Float	None
pattern_without_delimiter	String	None
byte	String	None
integer	Integer	None	[optional]
int32	Integer	None	[optional]
int64	Integer	None	[optional]
float	Float	None	[optional]
string	String	None	[optional]
binary	File	None	[optional]
date	Date	None	[optional]
date_time	Time	None	[optional]
password	String	None	[optional]
callback	String	None	[optional]

Return type

nil (empty response body)

Authorization

http_basic_test

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

test_enum_parameters

test_enum_parameters(opts)

To test enum parameters

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
opts = {
  enum_header_string_array: ['>'], # Array<String> | Header parameter enum test (string array)
  enum_header_string: '_abc', # String | Header parameter enum test (string)
  enum_query_string_array: ['>'], # Array<String> | Query parameter enum test (string array)
  enum_query_string: '_abc', # String | Query parameter enum test (string)
  enum_query_integer: 1, # Integer | Query parameter enum test (double)
  enum_query_double: 1.1, # Float | Query parameter enum test (double)
  enum_query_model_array: [Petstore::EnumClass::ABC], # Array<EnumClass> | 
  enum_form_string_array: ['>'], # Array<String> | Form parameter enum test (string array)
  enum_form_string: '_abc' # String | Form parameter enum test (string)
}

begin
  # To test enum parameters
  api_instance.test_enum_parameters(opts)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_enum_parameters: #{e}"
end

Using the test_enum_parameters_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> test_enum_parameters_with_http_info(opts)

begin
  # To test enum parameters
  data, status_code, headers = api_instance.test_enum_parameters_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_enum_parameters_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
enum_header_string_array	Array<String>	Header parameter enum test (string array)	[optional]
enum_header_string	String	Header parameter enum test (string)	[optional][default to '-efg']
enum_query_string_array	Array<String>	Query parameter enum test (string array)	[optional]
enum_query_string	String	Query parameter enum test (string)	[optional][default to '-efg']
enum_query_integer	Integer	Query parameter enum test (double)	[optional]
enum_query_double	Float	Query parameter enum test (double)	[optional]
enum_query_model_array	Array<EnumClass>		[optional]
enum_form_string_array	Array<String>	Form parameter enum test (string array)	[optional][default to '$']
enum_form_string	String	Form parameter enum test (string)	[optional][default to '-efg']

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

test_group_parameters

test_group_parameters(opts)

Fake endpoint to test group parameters (optional)

Examples

require 'time'
require 'petstore'
# setup authorization
Petstore.configure do |config|
  # Configure Bearer authorization (JWT): bearer_test
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Petstore::FakeApi.new
opts = {
    required_string_group: 56, # Integer | Required String in group parameters (required)
    required_boolean_group: true, # Boolean | Required Boolean in group parameters (required)
    required_int64_group: 789, # Integer | Required Integer in group parameters (required)
    string_group: 56, # Integer | String in group parameters
    boolean_group: true, # Boolean | Boolean in group parameters
    int64_group: 789, # Integer | Integer in group parameters
}

begin
  # Fake endpoint to test group parameters (optional)
  api_instance.test_group_parameters(opts)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_group_parameters: #{e}"
end

Using the test_group_parameters_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> test_group_parameters_with_http_info(opts)

begin
  # Fake endpoint to test group parameters (optional)
  data, status_code, headers = api_instance.test_group_parameters_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_group_parameters_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
required_string_group	Integer	Required String in group parameters
required_boolean_group	Boolean	Required Boolean in group parameters
required_int64_group	Integer	Required Integer in group parameters
string_group	Integer	String in group parameters	[optional]
boolean_group	Boolean	Boolean in group parameters	[optional]
int64_group	Integer	Integer in group parameters	[optional]

Return type

nil (empty response body)

Authorization

bearer_test

HTTP request headers

Content-Type: Not defined
Accept: Not defined

test_inline_additional_properties

test_inline_additional_properties(request_body)

test inline additionalProperties

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
request_body = { key: 'inner_example'} # Hash<String, String> | request body

begin
  # test inline additionalProperties
  api_instance.test_inline_additional_properties(request_body)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_inline_additional_properties: #{e}"
end

Using the test_inline_additional_properties_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> test_inline_additional_properties_with_http_info(request_body)

begin
  # test inline additionalProperties
  data, status_code, headers = api_instance.test_inline_additional_properties_with_http_info(request_body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_inline_additional_properties_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
request_body	Hash<String, String>	request body

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

test_inline_freeform_additional_properties

test_inline_freeform_additional_properties(test_inline_freeform_additional_properties_request)

test inline free-form additionalProperties

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
test_inline_freeform_additional_properties_request = Petstore::TestInlineFreeformAdditionalPropertiesRequest.new # TestInlineFreeformAdditionalPropertiesRequest | request body

begin
  # test inline free-form additionalProperties
  api_instance.test_inline_freeform_additional_properties(test_inline_freeform_additional_properties_request)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_inline_freeform_additional_properties: #{e}"
end

Using the test_inline_freeform_additional_properties_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> test_inline_freeform_additional_properties_with_http_info(test_inline_freeform_additional_properties_request)

begin
  # test inline free-form additionalProperties
  data, status_code, headers = api_instance.test_inline_freeform_additional_properties_with_http_info(test_inline_freeform_additional_properties_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_inline_freeform_additional_properties_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
test_inline_freeform_additional_properties_request	TestInlineFreeformAdditionalPropertiesRequest	request body

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

test_json_form_data

test_json_form_data(param, param2)

test json serialization of form data

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
param = 'param_example' # String | field1
param2 = 'param2_example' # String | field2

begin
  # test json serialization of form data
  api_instance.test_json_form_data(param, param2)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_json_form_data: #{e}"
end

Using the test_json_form_data_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> test_json_form_data_with_http_info(param, param2)

begin
  # test json serialization of form data
  data, status_code, headers = api_instance.test_json_form_data_with_http_info(param, param2)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_json_form_data_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
param	String	field1
param2	String	field2

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

test_query_parameter_collection_format

test_query_parameter_collection_format(pipe, ioutil, http, url, context, allow_empty, opts)

To test the collection format in query parameters

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
pipe = ['inner_example'] # Array<String> | 
ioutil = ['inner_example'] # Array<String> | 
http = ['inner_example'] # Array<String> | 
url = ['inner_example'] # Array<String> | 
context = ['inner_example'] # Array<String> | 
allow_empty = 'allow_empty_example' # String | 
opts = {
  language: { key: 'inner_example'} # Hash<String, String> | 
}

begin
  
  api_instance.test_query_parameter_collection_format(pipe, ioutil, http, url, context, allow_empty, opts)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_query_parameter_collection_format: #{e}"
end

Using the test_query_parameter_collection_format_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> test_query_parameter_collection_format_with_http_info(pipe, ioutil, http, url, context, allow_empty, opts)

begin
  
  data, status_code, headers = api_instance.test_query_parameter_collection_format_with_http_info(pipe, ioutil, http, url, context, allow_empty, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_query_parameter_collection_format_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
pipe	Array<String>
ioutil	Array<String>
http	Array<String>
url	Array<String>
context	Array<String>
allow_empty	String
language	Hash<String, String>	[optional]

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

test_string_map_reference

test_string_map_reference(request_body)

test referenced string map

Examples

require 'time'
require 'petstore'

api_instance = Petstore::FakeApi.new
request_body = { key: 'inner_example'} # Hash<String, String> | request body

begin
  # test referenced string map
  api_instance.test_string_map_reference(request_body)
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_string_map_reference: #{e}"
end

Using the test_string_map_reference_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> test_string_map_reference_with_http_info(request_body)

begin
  # test referenced string map
  data, status_code, headers = api_instance.test_string_map_reference_with_http_info(request_body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling FakeApi->test_string_map_reference_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
request_body	Hash<String, String>	request body

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

40 KiB Raw Blame History

Petstore::FakeApi

fake_big_decimal_map

Examples

Using the fake_big_decimal_map_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

fake_health_get

Examples

Using the fake_health_get_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

fake_http_signature_test

Examples

Using the fake_http_signature_test_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

fake_outer_boolean_serialize

Examples

Using the fake_outer_boolean_serialize_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

fake_outer_composite_serialize

Examples

Using the fake_outer_composite_serialize_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

fake_outer_number_serialize

Examples

Using the fake_outer_number_serialize_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

fake_outer_string_serialize

Examples

Using the fake_outer_string_serialize_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

fake_property_enum_integer_serialize

Examples

Using the fake_property_enum_integer_serialize_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_parameter_name_mapping

Examples

Using the get_parameter_name_mapping_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

test_additional_properties_reference

Examples

Using the test_additional_properties_reference_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

test_body_with_binary

Examples

Using the test_body_with_binary_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

test_body_with_file_schema

40 KiB

Raw Blame History