Skip to content
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

[poem-openapi] Use doc comment to generate Union variant documentation #894

Open
Zstorm999 opened this issue Oct 8, 2024 · 0 comments
Open
Labels
enhancement New feature or request

Comments

@Zstorm999
Copy link

Description of the feature

It would be nice to be able to document Unions directly from doc comments on the variant. Currently this does not work, and the documentation is extracted from the doc comment on the struct contained in the variant instead.

This behaviour does not seem consistent with what happens inside Objects, where doc comments on each field are used as the documentation in the generated api.

Feature example

#[derive(Union)]
enum MyEnum {
    /// variant A doc comment    <-- this is currently ignored
    A(Struct_A),
    /// variant B doc comment    <-- this is also currently ignored
    B(Struct_B),
}
@Zstorm999 Zstorm999 added the enhancement New feature or request label Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant