updated readme with disclaimer on Enum values #1070
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
|
Kwok-he-Chu
approved these changes
Oct 8, 2024
|
I've found several cases (but not limited to these* only), this will become a problem if the underlying integer value is stored instead of the respective
I have opened an issue/discussion for now. As of currently, adding one (alphabetical-ordered) enum in the OpenApi specifications results in an immediate breaking change when generating the library |
Merged
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.
Description
This PR updates the README to include a disclaimer regarding the potential for enum values to change in future releases. This change ensures that users are aware that they should not rely on the enum values being static, and should handle them dynamically or with caution in their implementations.
## Disclaimer on Enum Values.