Skip to content

[rust] support model/maps as deep/explode params #21262

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.

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
merged 5 commits into from
May 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,15 @@ impl<C: Connect>{{{classname}}} for {{{classname}}}Client<C>
{{/required}}
{{^required}}
if let Some(ref s) = {{{paramName}}} {
let query_value = {{#isArray}}s.iter().map(|s| s.to_string()).collect::<Vec<String>>().join(","){{/isArray}}{{^isArray}}s.to_string(){{/isArray}};
{{#isArray}}
let query_value = s.iter().map(|s| s.to_string()).collect::<Vec<String>>().join(",");
{{/isArray}}
{{^isArray}}
let query_value = match serde_json::to_string(s) {
Ok(value) => value,
Err(e) => return Box::pin(futures::future::err(Error::Serde(e))),
};
{{/isArray}}
req = req.with_query_param("{{{baseName}}}".to_string(), query_value);
}
{{/required}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,15 @@ impl<C: hyper::client::connect::Connect>{{{classname}}} for {{{classname}}}Clien
{{/required}}
{{^required}}
if let Some(ref s) = {{{paramName}}} {
let query_value = {{#isArray}}s.iter().map(|s| s.to_string()).collect::<Vec<String>>().join(","){{/isArray}}{{^isArray}}s.to_string(){{/isArray}};
{{#isArray}}
let query_value = s.iter().map(|s| s.to_string()).collect::<Vec<String>>().join(",");
{{/isArray}}
{{^isArray}}
let query_value = match serde_json::to_string(s) {
Ok(value) => value,
Err(e) => return Box::pin(futures::future::err(Error::Serde(e))),
};
{{/isArray}}
req = req.with_query_param("{{{baseName}}}".to_string(), query_value);
}
{{/required}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -192,36 +192,90 @@ impl {{classname}} for {{classname}}Client {
{{/isNullable}}
{{#isNullable}}
{{#isDeepObject}}
if let Some(ref local_var_str) = {{{paramName}}} {
let params = crate::apis::parse_deep_object("{{{baseName}}}", local_var_str);
{{^isExplode}}
if let Some(ref param_value) = {{{paramName}}} {
let params = crate::apis::parse_deep_object("{{{baseName}}}", &serde_json::to_value(param_value)?);
local_var_req_builder = local_var_req_builder.query(&params);
};
}
{{/isExplode}}
{{#isExplode}}
{{#isModel}}
if let Some(ref param_value) = {{{paramName}}} {
local_var_req_builder = local_var_req_builder.query(&param_value);
}
{{/isModel}}
{{#isMap}}
if let Some(ref param_value) = {{{paramName}}} {
let mut query_params = Vec::with_capacity(param_value.len());
for (key, value) in param_value.iter() {
query_params.push((key.to_string(), serde_json::to_string(value)?));
}
local_var_req_builder = local_var_req_builder.query(&query_params);
}
{{/isMap}}
{{/isExplode}}
{{/isDeepObject}}
{{^isDeepObject}}
if let Some(ref local_var_str) = {{{paramName}}} {
local_var_req_builder = local_var_req_builder.query(&[("{{{baseName}}}", &local_var_str.to_string())]);
{{#isObject}}
if let Some(ref param_value) = {{{paramName}}} {
local_var_req_builder = local_var_req_builder.query(&[("{{{baseName}}}", &serde_json::to_value(param_value)?)]);
};
{{/isObject}}
{{#isModel}}
if let Some(ref param_value) = {{{paramName}}} {
local_var_req_builder = local_var_req_builder.query(&[("{{{baseName}}}", &serde_json::to_value(param_value)?)]);
};
{{/isModel}}
{{^isObject}}
{{^isModel}}
if let Some(ref param_value) = {{{paramName}}} {
local_var_req_builder = local_var_req_builder.query(&[("{{{baseName}}}", &param_value.to_string())]);
};
{{/isModel}}
{{/isObject}}
{{/isDeepObject}}
{{/isNullable}}
{{/isArray}}
{{/required}}
{{^required}}
if let Some(ref local_var_str) = {{{paramName}}} {
if let Some(ref param_value) = {{{paramName}}} {
{{#isArray}}
local_var_req_builder = match "{{collectionFormat}}" {
"multi" => local_var_req_builder.query(&local_var_str.into_iter().map(|p| ("{{{baseName}}}".to_owned(), p.to_string())).collect::<Vec<(std::string::String, std::string::String)>>()),
_ => local_var_req_builder.query(&[("{{{baseName}}}", &local_var_str.into_iter().map(|p| p.to_string()).collect::<Vec<String>>().join(",").to_string())]),
"multi" => local_var_req_builder.query(&param_value.into_iter().map(|p| ("{{{baseName}}}".to_owned(), p.to_string())).collect::<Vec<(std::string::String, std::string::String)>>()),
_ => local_var_req_builder.query(&[("{{{baseName}}}", &param_value.into_iter().map(|p| p.to_string()).collect::<Vec<String>>().join(",").to_string())]),
};
{{/isArray}}
{{^isArray}}
{{#isDeepObject}}
let params = crate::apis::parse_deep_object("{{{baseName}}}", local_var_str);
{{^isExplode}}
let params = crate::apis::parse_deep_object("{{{baseName}}}", &serde_json::to_value(param_value)?);
local_var_req_builder = local_var_req_builder.query(&params);
{{/isExplode}}
{{#isExplode}}
{{#isModel}}
local_var_req_builder = local_var_req_builder.query(&param_value);
{{/isModel}}
{{#isMap}}
let mut query_params = Vec::with_capacity(param_value.len());
for (key, value) in param_value.iter() {
query_params.push((key.to_string(), serde_json::to_string(value)?));
}
local_var_req_builder = local_var_req_builder.query(&query_params);
{{/isMap}}
{{/isExplode}}
{{/isDeepObject}}
{{^isDeepObject}}
local_var_req_builder = local_var_req_builder.query(&[("{{{baseName}}}", &local_var_str.to_string())]);
{{#isObject}}
local_var_req_builder = local_var_req_builder.query(&[("{{{baseName}}}", &serde_json::to_value(param_value)?)]);
{{/isObject}}
{{#isModel}}
local_var_req_builder = local_var_req_builder.query(&[("{{{baseName}}}", &serde_json::to_value(param_value)?)]);
{{/isModel}}
{{^isObject}}
{{^isModel}}
local_var_req_builder = local_var_req_builder.query(&[("{{{baseName}}}", &param_value.to_string())]);
{{/isModel}}
{{/isObject}}
{{/isDeepObject}}
{{/isArray}}
}
{{/required}}
{{/queryParams}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,15 +160,43 @@ pub {{#supportAsync}}async {{/supportAsync}}fn {{{operationId}}}(configuration:
{{#isNullable}}
{{#isDeepObject}}
if let Some(ref param_value) = {{{vendorExtensions.x-rust-param-identifier}}} {
let params = crate::apis::parse_deep_object("{{{baseName}}}", param_value);
{{^isExplode}}
let params = crate::apis::parse_deep_object("{{{baseName}}}", &serde_json::to_value(param_value)?);
req_builder = req_builder.query(&params);
{{/isExplode}}
{{#isExplode}}
{{#isModel}}
req_builder = req_builder.query(&param_value);
{{/isModel}}
{{#isMap}}
let mut query_params = Vec::with_capacity(param_value.len());
for (key, value) in param_value.iter() {
query_params.push((key.to_string(), serde_json::to_string(value)?));
}
req_builder = req_builder.query(&query_params);
{{/isMap}}
{{/isExplode}}
};
{{/isDeepObject}}
{{^isDeepObject}}
{{#isObject}}
if let Some(ref param_value) = {{{vendorExtensions.x-rust-param-identifier}}} {
req_builder = req_builder.query(&[("{{{baseName}}}", &param_value.to_string())]);
req_builder = req_builder.query(&[("{{{baseName}}}", &serde_json::to_string(param_value)?)]);
};
{{/isObject}}
{{#isModel}}
if let Some(ref param_value) = {{{vendorExtensions.x-rust-param-identifier}}} {
req_builder = req_builder.query(&[("{{{baseName}}}", &serde_json::to_string(param_value)?)]);
};
{{/isModel}}
{{/isDeepObject}}
{{^isObject}}
{{^isModel}}
if let Some(ref param_value) = {{{vendorExtensions.x-rust-param-identifier}}} {
req_builder = req_builder.query(&[("{{{baseName}}}", &param_value.to_string())]);
};
{{/isModel}}
{{/isObject}}
{{/isNullable}}
{{/isArray}}
{{/required}}
Expand All @@ -182,11 +210,35 @@ pub {{#supportAsync}}async {{/supportAsync}}fn {{{operationId}}}(configuration:
{{/isArray}}
{{^isArray}}
{{#isDeepObject}}
let params = crate::apis::parse_deep_object("{{{baseName}}}", param_value);
{{^isExplode}}
let params = crate::apis::parse_deep_object("{{{baseName}}}", &serde_json::to_value(param_value)?);
req_builder = req_builder.query(&params);
{{/isExplode}}
{{#isExplode}}
{{#isModel}}
req_builder = req_builder.query(&param_value);
{{/isModel}}
{{#isMap}}
let mut query_params = Vec::with_capacity(param_value.len());
for (key, value) in param_value.iter() {
query_params.push((key.to_string(), serde_json::to_string(value)?));
}
req_builder = req_builder.query(&query_params);
{{/isMap}}
{{/isExplode}}
{{/isDeepObject}}
{{^isDeepObject}}
{{#isObject}}
req_builder = req_builder.query(&[("{{{baseName}}}", &serde_json::to_string(param_value)?)]);
{{/isObject}}
{{#isModel}}
req_builder = req_builder.query(&[("{{{baseName}}}", &serde_json::to_string(param_value)?)]);
{{/isModel}}
{{^isObject}}
{{^isModel}}
req_builder = req_builder.query(&[("{{{baseName}}}", &param_value.to_string())]);
{{/isModel}}
{{/isObject}}
{{/isDeepObject}}
{{/isArray}}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,49 @@ tags:
- name: user
description: Operations about user
paths:
/pets:
post:
tags:
- pet
summary: List all pets
description: Returns a list of pets
parameters:
- name: page
in: query
description: The page number
required: false
schema:
$ref: '#/components/schemas/Page'
responses:
'200':
description: A list of pets
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
'400':
description: Invalid page number
/pets/explode:
post:
tags:
- pet
summary: List all pets
description: Returns a list of pets
parameters:
- $ref: '#/components/parameters/PageExplode'
responses:
'200':
description: A list of pets
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
'400':
description: Invalid page number
/pet:
post:
tags:
Expand Down Expand Up @@ -1120,3 +1163,22 @@ components:
oneOf:
- $ref: '#/components/schemas/Order'
- $ref: '#/components/schemas/Order'
Page:
type: object
properties:
page:
type: integer
format: int32
perPage:
type: integer
format: int32
parameters:
PageExplode:
name: pageExplode
in: query
description: Object containing page `size` and page `number`.
required: false
style: deepObject
explode: true
schema:
$ref: '#/components/schemas/Page'
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ docs/NullableArray.md
docs/NumericEnumTesting.md
docs/OptionalTesting.md
docs/Order.md
docs/Page.md
docs/Person.md
docs/Pet.md
docs/PetApi.md
Expand Down Expand Up @@ -61,6 +62,7 @@ src/models/nullable_array.rs
src/models/numeric_enum_testing.rs
src/models/optional_testing.rs
src/models/order.rs
src/models/page.rs
src/models/person.rs
src/models/pet.rs
src/models/property_test.rs
Expand Down
3 changes: 3 additions & 0 deletions samples/client/petstore/rust/hyper/petstore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ Class | Method | HTTP request | Description
*PetApi* | [**find_pets_by_status**](docs/PetApi.md#find_pets_by_status) | **Get** /pet/findByStatus | Finds Pets by status
*PetApi* | [**find_pets_by_tags**](docs/PetApi.md#find_pets_by_tags) | **Get** /pet/findByTags | Finds Pets by tags
*PetApi* | [**get_pet_by_id**](docs/PetApi.md#get_pet_by_id) | **Get** /pet/{petId} | Find pet by ID
*PetApi* | [**pets_explode_post**](docs/PetApi.md#pets_explode_post) | **Post** /pets/explode | List all pets
*PetApi* | [**pets_post**](docs/PetApi.md#pets_post) | **Post** /pets | List all pets
*PetApi* | [**update_pet**](docs/PetApi.md#update_pet) | **Put** /pet | Update an existing pet
*PetApi* | [**update_pet_with_form**](docs/PetApi.md#update_pet_with_form) | **Post** /pet/{petId} | Updates a pet in the store with form data
*PetApi* | [**upload_file**](docs/PetApi.md#upload_file) | **Post** /pet/{petId}/uploadImage | uploads an image
Expand Down Expand Up @@ -68,6 +70,7 @@ Class | Method | HTTP request | Description
- [NumericEnumTesting](docs/NumericEnumTesting.md)
- [OptionalTesting](docs/OptionalTesting.md)
- [Order](docs/Order.md)
- [Page](docs/Page.md)
- [Person](docs/Person.md)
- [Pet](docs/Pet.md)
- [PropertyTest](docs/PropertyTest.md)
Expand Down
12 changes: 12 additions & 0 deletions samples/client/petstore/rust/hyper/petstore/docs/Page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Page

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | Option<**i32**> | | [optional]
**per_page** | Option<**i32**> | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading
Loading