poem-web / poem

A full-featured and easy-to-use web framework with the Rust programming language.
Apache License 2.0
3.62k stars 295 forks source link

refactor: change type name delimiters from <> () [] to _ #904

Open daxartio opened 3 weeks ago

daxartio commented 3 weeks ago

This change aligns with OpenAPI object naming conventions, where special characters like <, (), and [] can cause issues in schema generation and parsing. Replacing them with underscores (_) ensures compatibility with OpenAPI specifications, improving both readability and tool support.

This update maintains functionality while adhering to standard naming rules for better interoperability.

https://github.com/poem-web/poem/pull/671 https://github.com/poem-web/poem/issues/670 https://github.com/poem-web/poem/issues/774

daxartio commented 3 weeks ago

Hi, @sunli829 Could you please take a look at this PR and provide your advice? Thanks in advance!