Skip to content

Conversation

@DjoykeAbyah
Copy link
Contributor

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.

  • Added a new section in the README under ## Disclaimer on Enum Values.
  • Explained that enum values may be modified, added, or removed in future releases.

@DjoykeAbyah DjoykeAbyah requested a review from a team October 8, 2024 15:15
@DjoykeAbyah DjoykeAbyah requested a review from a team as a code owner October 8, 2024 15:15
@sonarqubecloud
Copy link

sonarqubecloud bot commented Oct 8, 2024

@Kwok-he-Chu
Copy link
Member

Kwok-he-Chu commented 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 string-value.

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

@DjoykeAbyah DjoykeAbyah merged commit 7050746 into main Oct 8, 2024
6 checks passed
@DjoykeAbyah DjoykeAbyah deleted the update-readme branch October 8, 2024 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants