Skip to content

fix(ruby): JSON-encode query params with content:application/json #24126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 3 commits into from
Jun 25, 2026
Merged

fix(ruby): JSON-encode query params with content:application/json #24126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
044523d
fix(ruby): JSON-encode query params with content:application/json
nbudin Jun 24, 2026
69196ff
Update samples/client/echo_api/ruby-httpx/lib/openapi_client/api/quer…
nbudin Jun 24, 2026
580c618
Regenerate samples after Cubic's suggested change
nbudin Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions modules/openapi-generator/src/main/resources/ruby-client/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,12 +176,22 @@ module {{moduleName}}
query_params = opts[:query_params] || {}
{{#queryParams}}
{{#required}}
{{#queryIsJsonMimeType}}
query_params[:'{{{baseName}}}'] = {{{paramName}}}.to_json
{{/queryIsJsonMimeType}}
{{^queryIsJsonMimeType}}
query_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
{{/queryIsJsonMimeType}}
{{/required}}
{{/queryParams}}
{{#queryParams}}
{{^required}}
{{#queryIsJsonMimeType}}
query_params[:'{{{baseName}}}'] = opts[:'{{{paramName}}}'].to_json if !opts[:'{{{paramName}}}'].nil?
{{/queryIsJsonMimeType}}
{{^queryIsJsonMimeType}}
query_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{{paramName}}}'].nil?
{{/queryIsJsonMimeType}}
{{/required}}
{{/queryParams}}

Expand Down
13 changes: 13 additions & 0 deletions .../openapi-generator/src/test/java/org/openapitools/codegen/ruby/RubyClientCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,4 +749,17 @@ public void testRegularExpressionOpenAPISchemaVersion3() {
// patten_starts_ends_with_slash '/root/'
Assert.assertEquals(op.allParams.get(8).pattern, "/root/");
}

@Test
public void testQueryParamJsonSerializationSetsQueryIsJsonMimeType() {
RubyClientCodegen codegen = new RubyClientCodegen();
final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/echo_api.yaml");
codegen.setOpenAPI(openAPI);
String path = "/query/style_jsonSerialization/object";
CodegenOperation op = codegen.fromOperation(path, "GET", openAPI.getPaths().get(path).getGet(), null);

Assert.assertEquals(op.queryParams.size(), 2);
assertTrue(op.queryParams.stream().allMatch(p -> p.queryIsJsonMimeType),
"All content:application/json query params should have queryIsJsonMimeType=true");
}
}
4 changes: 2 additions & 2 deletions samples/client/echo_api/ruby-faraday/lib/openapi_client/api/query_api.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -664,8 +664,8 @@ def test_query_style_json_serialization_object_with_http_info(opts = {})

# query parameters
query_params = opts[:query_params] || {}
query_params[:'json_serialized_object_ref_string_query'] = opts[:'json_serialized_object_ref_string_query'] if !opts[:'json_serialized_object_ref_string_query'].nil?
query_params[:'json_serialized_object_array_ref_string_query'] = @api_client.build_collection_param(opts[:'json_serialized_object_array_ref_string_query'], :csv) if !opts[:'json_serialized_object_array_ref_string_query'].nil?
query_params[:'json_serialized_object_ref_string_query'] = opts[:'json_serialized_object_ref_string_query'].to_json if !opts[:'json_serialized_object_ref_string_query'].nil?
query_params[:'json_serialized_object_array_ref_string_query'] = opts[:'json_serialized_object_array_ref_string_query'].to_json if !opts[:'json_serialized_object_array_ref_string_query'].nil?

# header parameters
header_params = opts[:header_params] || {}
Expand Down
4 changes: 2 additions & 2 deletions samples/client/echo_api/ruby-httpx/lib/openapi_client/api/query_api.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -664,8 +664,8 @@ def test_query_style_json_serialization_object_with_http_info(opts = {})

# query parameters
query_params = opts[:query_params] || {}
query_params[:'json_serialized_object_ref_string_query'] = opts[:'json_serialized_object_ref_string_query'] if !opts[:'json_serialized_object_ref_string_query'].nil?
query_params[:'json_serialized_object_array_ref_string_query'] = @api_client.build_collection_param(opts[:'json_serialized_object_array_ref_string_query'], :csv) if !opts[:'json_serialized_object_array_ref_string_query'].nil?
query_params[:'json_serialized_object_ref_string_query'] = opts[:'json_serialized_object_ref_string_query'].to_json if !opts[:'json_serialized_object_ref_string_query'].nil?
query_params[:'json_serialized_object_array_ref_string_query'] = opts[:'json_serialized_object_array_ref_string_query'].to_json if !opts[:'json_serialized_object_array_ref_string_query'].nil?

# header parameters
header_params = opts[:header_params] || {}
Expand Down
4 changes: 2 additions & 2 deletions samples/client/echo_api/ruby-typhoeus/lib/openapi_client/api/query_api.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -664,8 +664,8 @@ def test_query_style_json_serialization_object_with_http_info(opts = {})

# query parameters
query_params = opts[:query_params] || {}
query_params[:'json_serialized_object_ref_string_query'] = opts[:'json_serialized_object_ref_string_query'] if !opts[:'json_serialized_object_ref_string_query'].nil?
query_params[:'json_serialized_object_array_ref_string_query'] = @api_client.build_collection_param(opts[:'json_serialized_object_array_ref_string_query'], :csv) if !opts[:'json_serialized_object_array_ref_string_query'].nil?
query_params[:'json_serialized_object_ref_string_query'] = opts[:'json_serialized_object_ref_string_query'].to_json if !opts[:'json_serialized_object_ref_string_query'].nil?
query_params[:'json_serialized_object_array_ref_string_query'] = opts[:'json_serialized_object_array_ref_string_query'].to_json if !opts[:'json_serialized_object_array_ref_string_query'].nil?

# header parameters
header_params = opts[:header_params] || {}
Expand Down
Loading