mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-12-03 00:43:46 +00:00
add ruby httpx echo api tests (#16729)
This commit is contained in:
75
samples/client/echo_api/ruby-httpx/docs/AuthApi.md
Normal file
75
samples/client/echo_api/ruby-httpx/docs/AuthApi.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# OpenapiClient::AuthApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ------ | ------------ | ----------- |
|
||||
| [**test_auth_http_basic**](AuthApi.md#test_auth_http_basic) | **POST** /auth/http/basic | To test HTTP basic authentication |
|
||||
|
||||
|
||||
## test_auth_http_basic
|
||||
|
||||
> String test_auth_http_basic
|
||||
|
||||
To test HTTP basic authentication
|
||||
|
||||
To test HTTP basic authentication
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
# setup authorization
|
||||
OpenapiClient.configure do |config|
|
||||
# Configure HTTP basic authorization: http_auth
|
||||
config.username = 'YOUR USERNAME'
|
||||
config.password = 'YOUR PASSWORD'
|
||||
end
|
||||
|
||||
api_instance = OpenapiClient::AuthApi.new
|
||||
|
||||
begin
|
||||
# To test HTTP basic authentication
|
||||
result = api_instance.test_auth_http_basic
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling AuthApi->test_auth_http_basic: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_auth_http_basic_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_auth_http_basic_with_http_info
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# To test HTTP basic authentication
|
||||
data, status_code, headers = api_instance.test_auth_http_basic_with_http_info
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling AuthApi->test_auth_http_basic_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
[http_auth](../README.md#http_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
20
samples/client/echo_api/ruby-httpx/docs/Bird.md
Normal file
20
samples/client/echo_api/ruby-httpx/docs/Bird.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# OpenapiClient::Bird
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **size** | **String** | | [optional] |
|
||||
| **color** | **String** | | [optional] |
|
||||
|
||||
## Example
|
||||
|
||||
```ruby
|
||||
require 'openapi_client'
|
||||
|
||||
instance = OpenapiClient::Bird.new(
|
||||
size: null,
|
||||
color: null
|
||||
)
|
||||
```
|
||||
|
||||
469
samples/client/echo_api/ruby-httpx/docs/BodyApi.md
Normal file
469
samples/client/echo_api/ruby-httpx/docs/BodyApi.md
Normal file
@@ -0,0 +1,469 @@
|
||||
# OpenapiClient::BodyApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ------ | ------------ | ----------- |
|
||||
| [**test_binary_gif**](BodyApi.md#test_binary_gif) | **POST** /binary/gif | Test binary (gif) response body |
|
||||
| [**test_body_application_octetstream_binary**](BodyApi.md#test_body_application_octetstream_binary) | **POST** /body/application/octetstream/binary | Test body parameter(s) |
|
||||
| [**test_body_multipart_formdata_array_of_binary**](BodyApi.md#test_body_multipart_formdata_array_of_binary) | **POST** /body/application/octetstream/array_of_binary | Test array of binary in multipart mime |
|
||||
| [**test_echo_body_free_form_object_response_string**](BodyApi.md#test_echo_body_free_form_object_response_string) | **POST** /echo/body/FreeFormObject/response_string | Test free form object |
|
||||
| [**test_echo_body_pet**](BodyApi.md#test_echo_body_pet) | **POST** /echo/body/Pet | Test body parameter(s) |
|
||||
| [**test_echo_body_pet_response_string**](BodyApi.md#test_echo_body_pet_response_string) | **POST** /echo/body/Pet/response_string | Test empty response body |
|
||||
| [**test_echo_body_tag_response_string**](BodyApi.md#test_echo_body_tag_response_string) | **POST** /echo/body/Tag/response_string | Test empty json (request body) |
|
||||
|
||||
|
||||
## test_binary_gif
|
||||
|
||||
> File test_binary_gif
|
||||
|
||||
Test binary (gif) response body
|
||||
|
||||
Test binary (gif) response body
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::BodyApi.new
|
||||
|
||||
begin
|
||||
# Test binary (gif) response body
|
||||
result = api_instance.test_binary_gif
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_binary_gif: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_binary_gif_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(File, Integer, Hash)> test_binary_gif_with_http_info
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test binary (gif) response body
|
||||
data, status_code, headers = api_instance.test_binary_gif_with_http_info
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => File
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_binary_gif_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
**File**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: image/gif
|
||||
|
||||
|
||||
## test_body_application_octetstream_binary
|
||||
|
||||
> String test_body_application_octetstream_binary(opts)
|
||||
|
||||
Test body parameter(s)
|
||||
|
||||
Test body parameter(s)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::BodyApi.new
|
||||
opts = {
|
||||
body: File.new('/path/to/some/file') # File |
|
||||
}
|
||||
|
||||
begin
|
||||
# Test body parameter(s)
|
||||
result = api_instance.test_body_application_octetstream_binary(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_body_application_octetstream_binary: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_body_application_octetstream_binary_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_body_application_octetstream_binary_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test body parameter(s)
|
||||
data, status_code, headers = api_instance.test_body_application_octetstream_binary_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_body_application_octetstream_binary_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **body** | **File** | | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/octet-stream
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
## test_body_multipart_formdata_array_of_binary
|
||||
|
||||
> String test_body_multipart_formdata_array_of_binary(files)
|
||||
|
||||
Test array of binary in multipart mime
|
||||
|
||||
Test array of binary in multipart mime
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::BodyApi.new
|
||||
files = [File.new('/path/to/some/file')] # Array<File> |
|
||||
|
||||
begin
|
||||
# Test array of binary in multipart mime
|
||||
result = api_instance.test_body_multipart_formdata_array_of_binary(files)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_body_multipart_formdata_array_of_binary: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_body_multipart_formdata_array_of_binary_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_body_multipart_formdata_array_of_binary_with_http_info(files)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test array of binary in multipart mime
|
||||
data, status_code, headers = api_instance.test_body_multipart_formdata_array_of_binary_with_http_info(files)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_body_multipart_formdata_array_of_binary_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **files** | **Array<File>** | | |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: multipart/form-data
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
## test_echo_body_free_form_object_response_string
|
||||
|
||||
> String test_echo_body_free_form_object_response_string(opts)
|
||||
|
||||
Test free form object
|
||||
|
||||
Test free form object
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::BodyApi.new
|
||||
opts = {
|
||||
body: { ... } # Object | Free form object
|
||||
}
|
||||
|
||||
begin
|
||||
# Test free form object
|
||||
result = api_instance.test_echo_body_free_form_object_response_string(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_echo_body_free_form_object_response_string: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_echo_body_free_form_object_response_string_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_echo_body_free_form_object_response_string_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test free form object
|
||||
data, status_code, headers = api_instance.test_echo_body_free_form_object_response_string_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_echo_body_free_form_object_response_string_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **body** | **Object** | Free form object | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
## test_echo_body_pet
|
||||
|
||||
> <Pet> test_echo_body_pet(opts)
|
||||
|
||||
Test body parameter(s)
|
||||
|
||||
Test body parameter(s)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::BodyApi.new
|
||||
opts = {
|
||||
pet: OpenapiClient::Pet.new({name: 'doggie', photo_urls: ['photo_urls_example']}) # Pet | Pet object that needs to be added to the store
|
||||
}
|
||||
|
||||
begin
|
||||
# Test body parameter(s)
|
||||
result = api_instance.test_echo_body_pet(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_echo_body_pet: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_echo_body_pet_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(<Pet>, Integer, Hash)> test_echo_body_pet_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test body parameter(s)
|
||||
data, status_code, headers = api_instance.test_echo_body_pet_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => <Pet>
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_echo_body_pet_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **pet** | [**Pet**](Pet.md) | Pet object that needs to be added to the store | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Pet**](Pet.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## test_echo_body_pet_response_string
|
||||
|
||||
> String test_echo_body_pet_response_string(opts)
|
||||
|
||||
Test empty response body
|
||||
|
||||
Test empty response body
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::BodyApi.new
|
||||
opts = {
|
||||
pet: OpenapiClient::Pet.new({name: 'doggie', photo_urls: ['photo_urls_example']}) # Pet | Pet object that needs to be added to the store
|
||||
}
|
||||
|
||||
begin
|
||||
# Test empty response body
|
||||
result = api_instance.test_echo_body_pet_response_string(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_echo_body_pet_response_string: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_echo_body_pet_response_string_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_echo_body_pet_response_string_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test empty response body
|
||||
data, status_code, headers = api_instance.test_echo_body_pet_response_string_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_echo_body_pet_response_string_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **pet** | [**Pet**](Pet.md) | Pet object that needs to be added to the store | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
## test_echo_body_tag_response_string
|
||||
|
||||
> String test_echo_body_tag_response_string(opts)
|
||||
|
||||
Test empty json (request body)
|
||||
|
||||
Test empty json (request body)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::BodyApi.new
|
||||
opts = {
|
||||
tag: OpenapiClient::Tag.new # Tag | Tag object
|
||||
}
|
||||
|
||||
begin
|
||||
# Test empty json (request body)
|
||||
result = api_instance.test_echo_body_tag_response_string(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_echo_body_tag_response_string: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_echo_body_tag_response_string_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_echo_body_tag_response_string_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test empty json (request body)
|
||||
data, status_code, headers = api_instance.test_echo_body_tag_response_string_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling BodyApi->test_echo_body_tag_response_string_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **tag** | [**Tag**](Tag.md) | Tag object | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: text/plain
|
||||
|
||||
20
samples/client/echo_api/ruby-httpx/docs/Category.md
Normal file
20
samples/client/echo_api/ruby-httpx/docs/Category.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# OpenapiClient::Category
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **id** | **Integer** | | [optional] |
|
||||
| **name** | **String** | | [optional] |
|
||||
|
||||
## Example
|
||||
|
||||
```ruby
|
||||
require 'openapi_client'
|
||||
|
||||
instance = OpenapiClient::Category.new(
|
||||
id: 1,
|
||||
name: Dogs
|
||||
)
|
||||
```
|
||||
|
||||
22
samples/client/echo_api/ruby-httpx/docs/DataQuery.md
Normal file
22
samples/client/echo_api/ruby-httpx/docs/DataQuery.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# OpenapiClient::DataQuery
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **suffix** | **String** | test suffix | [optional] |
|
||||
| **text** | **String** | Some text containing white spaces | [optional] |
|
||||
| **date** | **Time** | A date | [optional] |
|
||||
|
||||
## Example
|
||||
|
||||
```ruby
|
||||
require 'openapi_client'
|
||||
|
||||
instance = OpenapiClient::DataQuery.new(
|
||||
suffix: null,
|
||||
text: Some text,
|
||||
date: null
|
||||
)
|
||||
```
|
||||
|
||||
32
samples/client/echo_api/ruby-httpx/docs/DefaultValue.md
Normal file
32
samples/client/echo_api/ruby-httpx/docs/DefaultValue.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# OpenapiClient::DefaultValue
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **array_string_enum_ref_default** | [**Array<StringEnumRef>**](StringEnumRef.md) | | [optional] |
|
||||
| **array_string_enum_default** | **Array<String>** | | [optional] |
|
||||
| **array_string_default** | **Array<String>** | | [optional] |
|
||||
| **array_integer_default** | **Array<Integer>** | | [optional] |
|
||||
| **array_string** | **Array<String>** | | [optional] |
|
||||
| **array_string_nullable** | **Array<String>** | | [optional] |
|
||||
| **array_string_extension_nullable** | **Array<String>** | | [optional] |
|
||||
| **string_nullable** | **String** | | [optional] |
|
||||
|
||||
## Example
|
||||
|
||||
```ruby
|
||||
require 'openapi_client'
|
||||
|
||||
instance = OpenapiClient::DefaultValue.new(
|
||||
array_string_enum_ref_default: null,
|
||||
array_string_enum_default: null,
|
||||
array_string_default: null,
|
||||
array_integer_default: null,
|
||||
array_string: null,
|
||||
array_string_nullable: null,
|
||||
array_string_extension_nullable: null,
|
||||
string_nullable: null
|
||||
)
|
||||
```
|
||||
|
||||
155
samples/client/echo_api/ruby-httpx/docs/FormApi.md
Normal file
155
samples/client/echo_api/ruby-httpx/docs/FormApi.md
Normal file
@@ -0,0 +1,155 @@
|
||||
# OpenapiClient::FormApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ------ | ------------ | ----------- |
|
||||
| [**test_form_integer_boolean_string**](FormApi.md#test_form_integer_boolean_string) | **POST** /form/integer/boolean/string | Test form parameter(s) |
|
||||
| [**test_form_oneof**](FormApi.md#test_form_oneof) | **POST** /form/oneof | Test form parameter(s) for oneOf schema |
|
||||
|
||||
|
||||
## test_form_integer_boolean_string
|
||||
|
||||
> String test_form_integer_boolean_string(opts)
|
||||
|
||||
Test form parameter(s)
|
||||
|
||||
Test form parameter(s)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::FormApi.new
|
||||
opts = {
|
||||
integer_form: 56, # Integer |
|
||||
boolean_form: true, # Boolean |
|
||||
string_form: 'string_form_example' # String |
|
||||
}
|
||||
|
||||
begin
|
||||
# Test form parameter(s)
|
||||
result = api_instance.test_form_integer_boolean_string(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling FormApi->test_form_integer_boolean_string: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_form_integer_boolean_string_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_form_integer_boolean_string_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test form parameter(s)
|
||||
data, status_code, headers = api_instance.test_form_integer_boolean_string_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling FormApi->test_form_integer_boolean_string_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **integer_form** | **Integer** | | [optional] |
|
||||
| **boolean_form** | **Boolean** | | [optional] |
|
||||
| **string_form** | **String** | | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/x-www-form-urlencoded
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
## test_form_oneof
|
||||
|
||||
> String test_form_oneof(opts)
|
||||
|
||||
Test form parameter(s) for oneOf schema
|
||||
|
||||
Test form parameter(s) for oneOf schema
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::FormApi.new
|
||||
opts = {
|
||||
form1: 'form1_example', # String |
|
||||
form2: 56, # Integer |
|
||||
form3: 'form3_example', # String |
|
||||
form4: true, # Boolean |
|
||||
id: 789, # Integer |
|
||||
name: 'name_example' # String |
|
||||
}
|
||||
|
||||
begin
|
||||
# Test form parameter(s) for oneOf schema
|
||||
result = api_instance.test_form_oneof(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling FormApi->test_form_oneof: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_form_oneof_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_form_oneof_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test form parameter(s) for oneOf schema
|
||||
data, status_code, headers = api_instance.test_form_oneof_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling FormApi->test_form_oneof_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **form1** | **String** | | [optional] |
|
||||
| **form2** | **Integer** | | [optional] |
|
||||
| **form3** | **String** | | [optional] |
|
||||
| **form4** | **Boolean** | | [optional] |
|
||||
| **id** | **Integer** | | [optional] |
|
||||
| **name** | **String** | | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/x-www-form-urlencoded
|
||||
- **Accept**: text/plain
|
||||
|
||||
78
samples/client/echo_api/ruby-httpx/docs/HeaderApi.md
Normal file
78
samples/client/echo_api/ruby-httpx/docs/HeaderApi.md
Normal file
@@ -0,0 +1,78 @@
|
||||
# OpenapiClient::HeaderApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ------ | ------------ | ----------- |
|
||||
| [**test_header_integer_boolean_string**](HeaderApi.md#test_header_integer_boolean_string) | **GET** /header/integer/boolean/string | Test header parameter(s) |
|
||||
|
||||
|
||||
## test_header_integer_boolean_string
|
||||
|
||||
> String test_header_integer_boolean_string(opts)
|
||||
|
||||
Test header parameter(s)
|
||||
|
||||
Test header parameter(s)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
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 |
|
||||
}
|
||||
|
||||
begin
|
||||
# Test header parameter(s)
|
||||
result = api_instance.test_header_integer_boolean_string(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling HeaderApi->test_header_integer_boolean_string: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_header_integer_boolean_string_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_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test header parameter(s)
|
||||
data, status_code, headers = api_instance.test_header_integer_boolean_string_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_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **integer_header** | **Integer** | | [optional] |
|
||||
| **boolean_header** | **Boolean** | | [optional] |
|
||||
| **string_header** | **String** | | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# OpenapiClient::NumberPropertiesOnly
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **number** | **Float** | | [optional] |
|
||||
| **float** | **Float** | | [optional] |
|
||||
| **double** | **Float** | | [optional] |
|
||||
|
||||
## Example
|
||||
|
||||
```ruby
|
||||
require 'openapi_client'
|
||||
|
||||
instance = OpenapiClient::NumberPropertiesOnly.new(
|
||||
number: null,
|
||||
float: null,
|
||||
double: null
|
||||
)
|
||||
```
|
||||
|
||||
74
samples/client/echo_api/ruby-httpx/docs/PathApi.md
Normal file
74
samples/client/echo_api/ruby-httpx/docs/PathApi.md
Normal file
@@ -0,0 +1,74 @@
|
||||
# OpenapiClient::PathApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ------ | ------------ | ----------- |
|
||||
| [**tests_path_string_path_string_integer_path_integer**](PathApi.md#tests_path_string_path_string_integer_path_integer) | **GET** /path/string/{path_string}/integer/{path_integer} | Test path parameter(s) |
|
||||
|
||||
|
||||
## tests_path_string_path_string_integer_path_integer
|
||||
|
||||
> String tests_path_string_path_string_integer_path_integer(path_string, path_integer)
|
||||
|
||||
Test path parameter(s)
|
||||
|
||||
Test path parameter(s)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::PathApi.new
|
||||
path_string = 'path_string_example' # String |
|
||||
path_integer = 56 # Integer |
|
||||
|
||||
begin
|
||||
# Test path parameter(s)
|
||||
result = api_instance.tests_path_string_path_string_integer_path_integer(path_string, path_integer)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling PathApi->tests_path_string_path_string_integer_path_integer: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the tests_path_string_path_string_integer_path_integer_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> tests_path_string_path_string_integer_path_integer_with_http_info(path_string, path_integer)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test path parameter(s)
|
||||
data, status_code, headers = api_instance.tests_path_string_path_string_integer_path_integer_with_http_info(path_string, path_integer)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling PathApi->tests_path_string_path_string_integer_path_integer_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **path_string** | **String** | | |
|
||||
| **path_integer** | **Integer** | | |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
28
samples/client/echo_api/ruby-httpx/docs/Pet.md
Normal file
28
samples/client/echo_api/ruby-httpx/docs/Pet.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# OpenapiClient::Pet
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **id** | **Integer** | | [optional] |
|
||||
| **name** | **String** | | |
|
||||
| **category** | [**Category**](Category.md) | | [optional] |
|
||||
| **photo_urls** | **Array<String>** | | |
|
||||
| **tags** | [**Array<Tag>**](Tag.md) | | [optional] |
|
||||
| **status** | **String** | pet status in the store | [optional] |
|
||||
|
||||
## Example
|
||||
|
||||
```ruby
|
||||
require 'openapi_client'
|
||||
|
||||
instance = OpenapiClient::Pet.new(
|
||||
id: 10,
|
||||
name: doggie,
|
||||
category: null,
|
||||
photo_urls: null,
|
||||
tags: null,
|
||||
status: null
|
||||
)
|
||||
```
|
||||
|
||||
20
samples/client/echo_api/ruby-httpx/docs/Query.md
Normal file
20
samples/client/echo_api/ruby-httpx/docs/Query.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# OpenapiClient::Query
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **id** | **Integer** | Query | [optional] |
|
||||
| **outcomes** | **Array<String>** | | [optional] |
|
||||
|
||||
## Example
|
||||
|
||||
```ruby
|
||||
require 'openapi_client'
|
||||
|
||||
instance = OpenapiClient::Query.new(
|
||||
id: null,
|
||||
outcomes: null
|
||||
)
|
||||
```
|
||||
|
||||
551
samples/client/echo_api/ruby-httpx/docs/QueryApi.md
Normal file
551
samples/client/echo_api/ruby-httpx/docs/QueryApi.md
Normal file
@@ -0,0 +1,551 @@
|
||||
# OpenapiClient::QueryApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| ------ | ------------ | ----------- |
|
||||
| [**test_enum_ref_string**](QueryApi.md#test_enum_ref_string) | **GET** /query/enum_ref_string | Test query parameter(s) |
|
||||
| [**test_query_datetime_date_string**](QueryApi.md#test_query_datetime_date_string) | **GET** /query/datetime/date/string | Test query parameter(s) |
|
||||
| [**test_query_integer_boolean_string**](QueryApi.md#test_query_integer_boolean_string) | **GET** /query/integer/boolean/string | Test query parameter(s) |
|
||||
| [**test_query_style_deep_object_explode_true_object**](QueryApi.md#test_query_style_deep_object_explode_true_object) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) |
|
||||
| [**test_query_style_deep_object_explode_true_object_all_of**](QueryApi.md#test_query_style_deep_object_explode_true_object_all_of) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) |
|
||||
| [**test_query_style_form_explode_true_array_string**](QueryApi.md#test_query_style_form_explode_true_array_string) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) |
|
||||
| [**test_query_style_form_explode_true_object**](QueryApi.md#test_query_style_form_explode_true_object) | **GET** /query/style_form/explode_true/object | Test query parameter(s) |
|
||||
| [**test_query_style_form_explode_true_object_all_of**](QueryApi.md#test_query_style_form_explode_true_object_all_of) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) |
|
||||
|
||||
|
||||
## test_enum_ref_string
|
||||
|
||||
> String test_enum_ref_string(opts)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::QueryApi.new
|
||||
opts = {
|
||||
enum_ref_string_query: OpenapiClient::StringEnumRef::SUCCESS # StringEnumRef |
|
||||
}
|
||||
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
result = api_instance.test_enum_ref_string(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_enum_ref_string: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_enum_ref_string_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_enum_ref_string_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
data, status_code, headers = api_instance.test_enum_ref_string_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_enum_ref_string_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **enum_ref_string_query** | [**StringEnumRef**](.md) | | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
## test_query_datetime_date_string
|
||||
|
||||
> String test_query_datetime_date_string(opts)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::QueryApi.new
|
||||
opts = {
|
||||
datetime_query: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
||||
date_query: Date.parse('2013-10-20'), # Date |
|
||||
string_query: 'string_query_example' # String |
|
||||
}
|
||||
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
result = api_instance.test_query_datetime_date_string(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_datetime_date_string: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_query_datetime_date_string_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_query_datetime_date_string_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
data, status_code, headers = api_instance.test_query_datetime_date_string_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_datetime_date_string_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **datetime_query** | **Time** | | [optional] |
|
||||
| **date_query** | **Date** | | [optional] |
|
||||
| **string_query** | **String** | | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
## test_query_integer_boolean_string
|
||||
|
||||
> String test_query_integer_boolean_string(opts)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::QueryApi.new
|
||||
opts = {
|
||||
integer_query: 56, # Integer |
|
||||
boolean_query: true, # Boolean |
|
||||
string_query: 'string_query_example' # String |
|
||||
}
|
||||
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
result = api_instance.test_query_integer_boolean_string(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_integer_boolean_string: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_query_integer_boolean_string_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_query_integer_boolean_string_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
data, status_code, headers = api_instance.test_query_integer_boolean_string_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_integer_boolean_string_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **integer_query** | **Integer** | | [optional] |
|
||||
| **boolean_query** | **Boolean** | | [optional] |
|
||||
| **string_query** | **String** | | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
## test_query_style_deep_object_explode_true_object
|
||||
|
||||
> String test_query_style_deep_object_explode_true_object(opts)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::QueryApi.new
|
||||
opts = {
|
||||
query_object: OpenapiClient::Pet.new({name: 'doggie', photo_urls: ['photo_urls_example']}) # Pet |
|
||||
}
|
||||
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
result = api_instance.test_query_style_deep_object_explode_true_object(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_style_deep_object_explode_true_object: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_query_style_deep_object_explode_true_object_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_query_style_deep_object_explode_true_object_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
data, status_code, headers = api_instance.test_query_style_deep_object_explode_true_object_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_style_deep_object_explode_true_object_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **query_object** | [**Pet**](.md) | | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
## test_query_style_deep_object_explode_true_object_all_of
|
||||
|
||||
> String test_query_style_deep_object_explode_true_object_all_of(opts)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::QueryApi.new
|
||||
opts = {
|
||||
query_object: OpenapiClient::TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter.new # TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter |
|
||||
}
|
||||
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
result = api_instance.test_query_style_deep_object_explode_true_object_all_of(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_style_deep_object_explode_true_object_all_of: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_query_style_deep_object_explode_true_object_all_of_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_query_style_deep_object_explode_true_object_all_of_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
data, status_code, headers = api_instance.test_query_style_deep_object_explode_true_object_all_of_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_style_deep_object_explode_true_object_all_of_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **query_object** | [**TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter**](.md) | | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
## test_query_style_form_explode_true_array_string
|
||||
|
||||
> String test_query_style_form_explode_true_array_string(opts)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::QueryApi.new
|
||||
opts = {
|
||||
query_object: OpenapiClient::TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.new # TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter |
|
||||
}
|
||||
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
result = api_instance.test_query_style_form_explode_true_array_string(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_style_form_explode_true_array_string: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_query_style_form_explode_true_array_string_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_query_style_form_explode_true_array_string_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
data, status_code, headers = api_instance.test_query_style_form_explode_true_array_string_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_style_form_explode_true_array_string_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **query_object** | [**TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter**](.md) | | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
## test_query_style_form_explode_true_object
|
||||
|
||||
> String test_query_style_form_explode_true_object(opts)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::QueryApi.new
|
||||
opts = {
|
||||
query_object: OpenapiClient::Pet.new({name: 'doggie', photo_urls: ['photo_urls_example']}) # Pet |
|
||||
}
|
||||
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
result = api_instance.test_query_style_form_explode_true_object(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_style_form_explode_true_object: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_query_style_form_explode_true_object_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_query_style_form_explode_true_object_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
data, status_code, headers = api_instance.test_query_style_form_explode_true_object_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_style_form_explode_true_object_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **query_object** | [**Pet**](.md) | | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
## test_query_style_form_explode_true_object_all_of
|
||||
|
||||
> String test_query_style_form_explode_true_object_all_of(opts)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
require 'time'
|
||||
require 'openapi_client'
|
||||
|
||||
api_instance = OpenapiClient::QueryApi.new
|
||||
opts = {
|
||||
query_object: OpenapiClient::DataQuery.new # DataQuery |
|
||||
}
|
||||
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
result = api_instance.test_query_style_form_explode_true_object_all_of(opts)
|
||||
p result
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_style_form_explode_true_object_all_of: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the test_query_style_form_explode_true_object_all_of_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(String, Integer, Hash)> test_query_style_form_explode_true_object_all_of_with_http_info(opts)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# Test query parameter(s)
|
||||
data, status_code, headers = api_instance.test_query_style_form_explode_true_object_all_of_with_http_info(opts)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => String
|
||||
rescue OpenapiClient::ApiError => e
|
||||
puts "Error when calling QueryApi->test_query_style_form_explode_true_object_all_of_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **query_object** | [**DataQuery**](.md) | | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
15
samples/client/echo_api/ruby-httpx/docs/StringEnumRef.md
Normal file
15
samples/client/echo_api/ruby-httpx/docs/StringEnumRef.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# OpenapiClient::StringEnumRef
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
|
||||
## Example
|
||||
|
||||
```ruby
|
||||
require 'openapi_client'
|
||||
|
||||
instance = OpenapiClient::StringEnumRef.new()
|
||||
```
|
||||
|
||||
20
samples/client/echo_api/ruby-httpx/docs/Tag.md
Normal file
20
samples/client/echo_api/ruby-httpx/docs/Tag.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# OpenapiClient::Tag
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **id** | **Integer** | | [optional] |
|
||||
| **name** | **String** | | [optional] |
|
||||
|
||||
## Example
|
||||
|
||||
```ruby
|
||||
require 'openapi_client'
|
||||
|
||||
instance = OpenapiClient::Tag.new(
|
||||
id: null,
|
||||
name: null
|
||||
)
|
||||
```
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
# OpenapiClient::TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **size** | **String** | | [optional] |
|
||||
| **color** | **String** | | [optional] |
|
||||
| **id** | **Integer** | | [optional] |
|
||||
| **name** | **String** | | [optional] |
|
||||
|
||||
## Example
|
||||
|
||||
```ruby
|
||||
require 'openapi_client'
|
||||
|
||||
instance = OpenapiClient::TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter.new(
|
||||
size: null,
|
||||
color: null,
|
||||
id: 1,
|
||||
name: Dogs
|
||||
)
|
||||
```
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# OpenapiClient::TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
| **values** | **Array<String>** | | [optional] |
|
||||
|
||||
## Example
|
||||
|
||||
```ruby
|
||||
require 'openapi_client'
|
||||
|
||||
instance = OpenapiClient::TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.new(
|
||||
values: null
|
||||
)
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user