Demonstrate backward-compatible deprecation of enums #92
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
I would like to get rid of using C# enums in the SDK. They unnecessarily constrain the values that a user can send to the ShipEngine API. The API expects a string, the SDK should allow the user to specify a string. An enum requires converting values to an integer, which has no value for our purposes. It also leads to awkwardness when the default is `0`, which will correspond to an enum value we don't necessarily want. It requires the user to update their SDK any time there is a new possible value accepted by the API. We can still provide guidance for valid values via classes that expose static strings. However, there is likely code in the wild where users are setting properties to an enum value. This is an experiment to demonstrate using implicit conversion operators, and a custom JsonConverter, to allow a user to set a "string enum" value using a string or an enum.
Pull Request Test Coverage Report for Build 9670357484Details
💛 - Coveralls |
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.
I would like to get rid of using C# enums in the SDK. They unnecessarily constrain the
values that a user can send to the ShipEngine API. The API expects a string, the SDK
should allow the user to specify a string. An enum requires converting values to an integer,
which has no value for our purposes. It also leads to awkwardness when the default is
0,which will correspond to an enum value we don't necessarily want. It requires the user
to update their SDK any time there is a new possible value accepted by the API.
We can still provide guidance for valid values via classes that expose static strings.
However, there is likely code in the wild where users are setting properties to an enum value.
This is an experiment to demonstrate using implicit conversion operators, and a custom JsonConverter,
to allow a user to set a "string enum" value using a string or an enum.