This repository was archived by the owner on Oct 19, 2022. It is now read-only.
Allow marshmallow_enum to be used for OpenAPI schema definitions#38
Open
h wants to merge 7 commits intojustanr:masterfrom
Open
Allow marshmallow_enum to be used for OpenAPI schema definitions#38h wants to merge 7 commits intojustanr:masterfrom
h wants to merge 7 commits intojustanr:masterfrom
Conversation
Passing the enum through the custructor allows it to be used for OpenAPI schema definitions, an important use-case for marshmallow. Given it's the first parameter of the function, the risk of it being referenced by a client library by name is fairly small, and searching through public repositories in GitHub doesn't reveal any clients where this would be problematic.
The unused import was causing pytest to fail
Author
Author
|
@justanr Could you review the PR and let me know if this looks alright to you? We'd like to start using it to include enum fields in our autogenerated OpenAPI specs. Thanks! |
Merged
|
Time to make a move on this? |
kaos
reviewed
Apr 8, 2021
| ) | ||
|
|
||
| self.load_by = load_by | ||
| self.dump_by = dump_by |
There was a problem hiding this comment.
It is a backwards breaking change to not set these attributes. Better would be to set them based on the self.by_value attr for backwards compatibility.
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
Passing the enum through to the super-class allows it to be used for APISpec/OpenAPI schema definitions, an important use-case for marshmallow. Given that it's the first parameter of the function, the risk that the parameter was referenced by name in a client library is fairly small. Searching through public repositories in GitHub doesn't reveal any clients where this would be problematic.
OpenAPI does not permit the values to differ between loading/dumping. The
load_byanddump_byparameters are still accepted for backward compatibility, but they have been deprecated in favor of theby_valueparameter.