Add support for json schema oneOf enumStrategy#2504
Merged
haydenbaker merged 1 commit intosmithy-lang:mainfrom Feb 7, 2025
Merged
Add support for json schema oneOf enumStrategy#2504haydenbaker merged 1 commit intosmithy-lang:mainfrom
haydenbaker merged 1 commit intosmithy-lang:mainfrom
Conversation
This adds support for a new json schema setting, `enumStrategy`, that allows for variants `enum` (current behaviour, and default) and `oneOf` (gets converted to a oneOf with const string values, allowing for documentation of individual enum variants.)
haydenbaker
approved these changes
Feb 7, 2025
Contributor
|
Thank you for contributing this! |
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
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.
Background
This adds support for a new json schema setting,
enumStrategy, that allows for variantsenum(current behaviour, and default) andoneOf(gets converted to a oneOf with const string values, allowing for documentation of individual enum variants.)I'm new to this codebase, let me know if there are other considerations I may have missed here
Allows for documentation on enum variants in an open-api schema for example. The current behaviour (which will remain the default), doesn't allow documentation at the variant level
Testing
Added unit test cases to
JsonSchemaConverterTest.ran
./gradlew buildLinks
For: #2481
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.