Updated README to mention the support for JSON Schema compliant enums #882
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.
Updated README to mention the support for JSON Schema compliant drop-down enums
Reasons for making this change
PR #581 brought in support for
anyOf
-powered enums and added an Alternatives example in the playground but it still requires one to be aware of the difference in enums in that example or to find Issue #532 to understand how to use them so I added a section to the README.Notably this was a task "I've updated docs if needed" on #581 that was left undone and this is trying to make that task done. :)
Although I added a new sub-section I did not add it to the Table of Contents as it still applies to the header present in the ToC but if you feel that would be good to do then I totally can. In that case I think we should probably add a sub-section title to the existing enumNames approach for clarity but I'm not sure what it should be called.
Checklist
npm run cs-format
on my branch to conform my code to prettier coding style