loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-05 05:16:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Codegen parameter for query json serialization (#21718)

Browse Source 
* Add endpoints with query parameters that require Json-serialization

* Add property for query json-serialization

* Update samples

* Adjust indentation for specification
This commit is contained in:
Mattias Sehlstedt
2025-08-10 16:47:51 +02:00
committed by GitHub
parent 6ff9e67bad
commit 8874df4702
75 changed files with 4461 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
samples/client/echo_api/ruby-faraday/docs/QueryApi.md
View File

@@ -14,6 +14,7 @@ All URIs are relative to *http://localhost:3000*
| [**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_query_style_json_serialization_object**](QueryApi.md#test_query_style_json_serialization_object) | **GET** /query/style_jsonSerialization/object | Test query parameter(s) |
## test_enum_ref_string
@@ -685,3 +686,71 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: text/plain
## test_query_style_json_serialization_object
> String test_query_style_json_serialization_object(opts)
Test query parameter(s)
Test query parameter(s)
### Examples
```ruby
require 'time'
require 'openapi_client'
api_instance = OpenapiClient::QueryApi.new
opts = {
json_serialized_object_ref_string_query: OpenapiClient::Pet.new({name: 'doggie', photo_urls: ['photo_urls_example']}), # Pet |
json_serialized_object_array_ref_string_query: [OpenapiClient::Pet.new({name: 'doggie', photo_urls: ['photo_urls_example']})] # Array<Pet> |
}
begin
# Test query parameter(s)
result = api_instance.test_query_style_json_serialization_object(opts)
p result
rescue OpenapiClient::ApiError => e
puts "Error when calling QueryApi->test_query_style_json_serialization_object: #{e}"
end
```
#### Using the test_query_style_json_serialization_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_json_serialization_object_with_http_info(opts)
```ruby
begin
# Test query parameter(s)
data, status_code, headers = api_instance.test_query_style_json_serialization_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_json_serialization_object_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **json_serialized_object_ref_string_query** | [**Pet**](.md) | | [optional] |
| **json_serialized_object_array_ref_string_query** | [**Array&lt;Pet&gt;**](Pet.md) | | [optional] |
### Return type
**String**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain