Skip to content

Conversation

KevinLiddle
Copy link
Contributor

This is sort of a minor breaking change but I think it's still a breaking change, so I put it against 8.0.x. Let me know if you think otherwise.

cc @linxGnu

When generating Rust types for an object defined in the OpenAPI spec as type: string, the generated struct is a 1-tuple with the Display trait using the debug formatting (i.e. "{:?}"). This causes calls to to_string to output the value with quotes in the string.

Example:

components:
  schemas:
    Region:
      description: A geographic region
      type: string

The above schema generates the following type

#[derive(Debug, Clone, PartialEq, PartialOrd, serde::Serialize, serde::Deserialize)]
#[cfg_attr(feature = "conversion", derive(frunk::LabelledGeneric))]
pub struct Region(String);

impl validator::Validate for Region {
    fn validate(&self) -> std::result::Result<(), validator::ValidationErrors> {
        std::result::Result::Ok(())
    }
}

impl std::convert::From<String> for Region {
    fn from(x: String) -> Self {
        Region(x)
    }
}

impl std::fmt::Display for Region {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{:?}", self.0)
    }
}

impl std::str::FromStr for Region {
    type Err = std::string::ParseError;
    fn from_str(x: &str) -> std::result::Result<Self, Self::Err> {
        std::result::Result::Ok(Region(x.to_string()))
    }
}

impl std::convert::From<Region> for String {
    fn from(x: Region) -> Self {
        x.0
    }
}

impl std::ops::Deref for Region {
    type Target = String;
    fn deref(&self) -> &String {
        &self.0
    }
}

impl std::ops::DerefMut for Region {
    fn deref_mut(&mut self) -> &mut String {
        &mut self.0
    }
}

and if I call to_string on a Region, I will get the value with quotes

let r = Region("the city").to_string() //=> "\"the city\"";

If we change the format string to just "{}", then to_string results in a properly formatted string.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328
Copy link
Member

wing328 commented Oct 17, 2025

please target master to start with

we can consider it a bug fix to start with

@KevinLiddle KevinLiddle force-pushed the rust-axum/string-type-display-fix branch from 7f35afa to 60a5266 Compare October 17, 2025 17:00
@KevinLiddle KevinLiddle changed the base branch from 8.0.x to master October 17, 2025 17:00
@KevinLiddle
Copy link
Contributor Author

@wing328 changed base to master

@wing328 wing328 closed this Oct 18, 2025
@wing328 wing328 reopened this Oct 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants