Skip to content

Fix generation of null type for Option<T> #1468

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+110 −10
Open

Fix generation of null type for Option<T> #1468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
54 changes: 44 additions & 10 deletions utoipa-gen/src/component.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1263,14 +1263,30 @@ impl ComponentSchema {
.collect::<Array<_>>();

if index.is_some() {
quote_spanned! {type_path.span()=>
let _ = <#rewritten_path as utoipa::PartialSchema>::schema;

let composed_tokens = quote! {
if let Some(composed) = generics.get_mut(#index) {
composed.clone()
} else {
<#rewritten_path as utoipa::PartialSchema>::schema()
}
};

if default.is_some() || nullable {
quote_spanned! {type_path.span()=>
let _ = <#rewritten_path as utoipa::PartialSchema>::schema;

utoipa::openapi::schema::OneOfBuilder::new()
#nullable_item
.item(
#composed_tokens
)
}
} else {
quote_spanned! {type_path.span()=>
let _ = <#rewritten_path as utoipa::PartialSchema>::schema;

#composed_tokens
}
}
} else {
quote_spanned! {type_path.span()=>
Expand Down Expand Up @@ -1337,14 +1353,32 @@ impl ComponentSchema {
quote! { <#rewritten_path as utoipa::ToSchema>::schemas(schemas) };
let composed_or_ref = |item_tokens: TokenStream| -> TokenStream {
if let Some(index) = &index {
quote_spanned! {type_path.span()=>
{
let _ = <#rewritten_path as utoipa::PartialSchema>::schema;
let composed_tokens = quote! {
if let Some(composed) = generics.get_mut(#index) {
composed.clone()
} else {
#item_tokens.into()
}
};

if default.is_some() || nullable {
quote_spanned! {type_path.span()=>
{
let _ = <#rewritten_path as utoipa::PartialSchema>::schema;

utoipa::openapi::schema::OneOfBuilder::new()
#nullable_item
.item(
#composed_tokens
)
}
}
} else {
quote_spanned! {type_path.span()=>
{
let _ = <#rewritten_path as utoipa::PartialSchema>::schema;

if let Some(composed) = generics.get_mut(#index) {
composed.clone()
} else {
#item_tokens.into()
#composed_tokens
}
}
}
Expand Down
23 changes: 23 additions & 0 deletions utoipa-gen/tests/schema_generics.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,29 @@ fn schema_with_non_generic_root() {
assert_json_snapshot!(api);
}

#[test]
fn schema_option_generic() {
#![allow(unused)]

#[derive(ToSchema)]
struct Top {
bounds: Bounds<i32>,
}

#[derive(ToSchema)]
struct Bounds<T> {
min: Option<T>,
}

#[derive(OpenApi)]
#[openapi(components(schemas(Top)))]
struct ApiDoc;
let mut api = ApiDoc::openapi();
api.info = Info::new("title", "version");

assert_json_snapshot!(api);
}

#[test]
fn derive_generic_schema_enum_variants() {
#![allow(unused)]
Expand Down
43 changes: 43 additions & 0 deletions utoipa-gen/tests/snapshots/schema_generics__schema_option_generic.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
source: utoipa-gen/tests/schema_generics.rs
expression: api
---
{
"openapi": "3.1.0",
"info": {
"title": "title",
"version": "version"
},
"paths": {},
"components": {
"schemas": {
"Bounds_i32": {
"type": "object",
"properties": {
"min": {
"oneOf": [
{
"type": "null"
},
{
"type": "integer",
"format": "int32"
}
]
}
}
},
"Top": {
"type": "object",
"required": [
"bounds"
],
"properties": {
"bounds": {
"$ref": "#/components/schemas/Bounds_i32"
}
}
}
}
}
}