juhaku / utoipa

Simple, Fast, Code first and Compile time generated OpenAPI documentation for Rust
Apache License 2.0
2.49k stars 197 forks source link

Build error with schema name "Value" #1189

Open HollayHorvath opened 2 weeks ago

HollayHorvath commented 2 weeks ago

When I have a schema component with the name Value the #[derive(OpenApi)] produces unparsable tokens:

error: expected expression, found `,`
 --> src/main.rs:8:10
  |
8 | #[derive(OpenApi)]
  |          ^^^^^^^ expected expression
  |
  = note: this error originates in the derive macro `OpenApi` (in Nightly builds, run with -Z macro-backtrace for more info)

error: expected one of `.`, `;`, `?`, `else`, or an operator, found `)`
 --> src/main.rs:8:10
  |
8 | #[derive(OpenApi)]
  |          ^^^^^^^ expected one of `.`, `;`, `?`, `else`, or an operator
  |
  = note: this error originates in the derive macro `OpenApi` (in Nightly builds, run with -Z macro-backtrace for more info)

error: proc-macro derive produced unparsable tokens
 --> src/main.rs:8:10
  |
8 | #[derive(OpenApi)]
  |          ^^^^^^^

The repro itself is shorter than the error:

use utoipa::{OpenApi, ToSchema};

#[derive(ToSchema)]
struct Value {
    val: &'static str,
}

#[derive(OpenApi)]
#[openapi(components(schemas(Value)))]
struct Api;

fn main() {
    println!("Hello, world!");
}

Renaming the Value struct fixes the issue.

The error is quite hard to decipher as the error reported has nothing to do with the actual problem. It was working fine under Utoipa 4.x but it's broken under 5.0.

juhaku commented 1 week ago

Utoipa has Value and Object as reserved type names that will clash with other types if named similarly. Probably before utoipa has been lenient on that, but now everything needs explicit implementation for ToSchema which might have something to do with the error. This is due to fully support generics.

Value and Object types are used as meta names to indicate if type is just a json value or plain OpenAPI object. Changing this behavior would be a breaking change and needs further assessment what could be reasonable alternative for current behavior.