Support #[serde(flatten)] for maps.
#799
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`utoipa` already supported `#[serde(flatten)]` on fields with structure type, by putting the fields inside those structures into the parent type. This is commonly used for factoring out frequently used keys, as documented at <https://serde.rs/attr-flatten.html#factor-out-frequently-grouped-keys>. `#[serde(flatten)]` has another use that utoipa does not support: to capture additional unnamed fields within a structure, as documented at <https://serde.rs/attr-flatten.html#capture-additional-fields>. This commit adds support for that functionality as well as a pair of tests. It only makes sense to have one such field per structure, so this commit reports an error if there is more than one.
|
Thank you! |
blp
added a commit
to feldera/feldera
that referenced
this pull request
Nov 13, 2023
By upgrading to `utoipa` 4.1, we can take advantage of its new support for `#[serde(flatten)]` from juhaku/utoipa#799. This means we can drop the handwritten implementations. Signed-off-by: Ben Pfaff <blp@feldera.com>
blp
added a commit
to feldera/feldera
that referenced
this pull request
Nov 13, 2023
By upgrading to `utoipa` 4.1, we can take advantage of its new support for `#[serde(flatten)]` from juhaku/utoipa#799. This means we can drop the handwritten implementations. Fixes #1016. Signed-off-by: Ben Pfaff <blp@feldera.com>
blp
added a commit
to feldera/feldera
that referenced
this pull request
Nov 13, 2023
By upgrading to `utoipa` 4.1, we can take advantage of its new support for `#[serde(flatten)]` from juhaku/utoipa#799. This means we can drop the handwritten implementations. Also, remove unused `ToSchema` from `KafkaOutputConfig` outside of the `pipeline_types` crate. Fixes #1016. Signed-off-by: Ben Pfaff <blp@feldera.com>
blp
added a commit
to feldera/feldera
that referenced
this pull request
Nov 13, 2023
By upgrading to `utoipa` 4.1, we can take advantage of its new support for `#[serde(flatten)]` from juhaku/utoipa#799. This means we can drop the handwritten implementations. Also, remove unused `ToSchema` from `KafkaOutputConfig` outside of the `pipeline_types` crate. Fixes #1016. Signed-off-by: Ben Pfaff <blp@feldera.com>
blp
added a commit
to feldera/feldera
that referenced
this pull request
Nov 14, 2023
By upgrading to `utoipa` 4.1, we can take advantage of its new support for `#[serde(flatten)]` from juhaku/utoipa#799. This means we can drop the handwritten implementations. This changes the Python API client in a benign way. Fixes #1016. Signed-off-by: Ben Pfaff <blp@feldera.com>
blp
added a commit
to feldera/feldera
that referenced
this pull request
Nov 14, 2023
By upgrading to `utoipa` 4.1, we can take advantage of its new support for `#[serde(flatten)]` from juhaku/utoipa#799. This means we can drop the handwritten implementations. This changes the Python API client in a benign way. Fixes #1016. Signed-off-by: Ben Pfaff <blp@feldera.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
utoipaalready supported#[serde(flatten)]on fields with structure type, by putting the fields inside those structures into the parent type. This is commonly used for factoring out frequently used keys, as documented at https://serde.rs/attr-flatten.html#factor-out-frequently-grouped-keys.#[serde(flatten)]has another use that utoipa does not support: to capture additional unnamed fields within a structure, as documented at https://serde.rs/attr-flatten.html#capture-additional-fields. This commit adds support for that functionality as well as a pair of tests. It only makes sense to have one such field per structure, so this commit reports an error if there is more than one.