Add enum() method to Str class#75
Merged
tobyzerner merged 2 commits intotobyzerner:mainfrom Aug 23, 2023
Merged
Conversation
Owner
|
Great idea, thanks for the PR! I think I forgot about enums when I was implementing the data type features because they're on a separate page in the Swagger docs 😅 |
Owner
|
If you have a moment, could you please add this to the docs as well? |
Contributor
Author
Done in #76 ✅ |
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 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.
Hi,
I propose to add a new
enum()method on theStrclass. This would make validation of enum properties a lot easier, so we don't need to manually write something like this every time we have an enum property:It would also tie in nicely with the
enumkeyword in JSON schema which is used in OpenAPI specs, so it would also be possible to document the possible enum values in the auto-generated OpenAPI documentation that you are working on in #62See: https://json-schema.org/draft/2020-12/json-schema-validation.html#section-6.1
(Technically JSON schema allows this attribute on any type, but it seemed most useful to me on string fields for now. It could also be added to other fields later of course.)