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

fix(poem-openapi): handle additional_properties correctly in flatten #961

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

cristicbz
Copy link

Fixes the generated documentation for a type like

#[derive(Object)]
struct SomeObject {
    fixed: u32,

    #[oai(flatten)]
    items: HashMap<String, u64>
}

Currently, such a type shows no documentation for items, because HashMap<String, ...> only contains additionalProperties in the schema. This PR adds tracking of additionalProperties in addition to properties and required when using flatten.

In principle we can only support one flattened type with additionalProperties, but it wasn't clear to me how to enforce this, so instead this PR just keeps track of the additionalProperties of the LAST flatten-ed field.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant