-
Notifications
You must be signed in to change notification settings - Fork 6k
[csharp] fix enum serialization of first value #6873
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
wing328
merged 6 commits into
swagger-api:master
from
jimschubert:csharp-enum-serialization-6459
Nov 13, 2017
Merged
[csharp] fix enum serialization of first value #6873
wing328
merged 6 commits into
swagger-api:master
from
jimschubert:csharp-enum-serialization-6459
Nov 13, 2017
Conversation
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
C# works differently from most languages in that enums are not considered objects. This means default(EnumType) will choose a default of the first enum option. This isn't desirable because it breaks the required = false functionality of swagger specs, which defines a property which isn't required to exist in the message body. Rather than force consumers to use enum values such as UNSPECIFIED, UNKNOWN, NOT_SET, etc... we can treat enums as primitives. This means any non-required enum will become Nullable<EnumType> regardless of whether it is defined as an inline enum or a referenced enum model.
…ferent enum usage cases.
The EmitDefaultValue=false for string based enums will prevent the first
enum value from being serialized, because as 0 it is considered the
default.
This commit assigns an explicit numerical value to all non-integer
enums. This assignment has no effect on the
serialization/deserialization values, and only assigns the compiled
integer.
NOTE: This will have an effect of requiring recompilation of any code
that references the client/server models. This is because:
public enum Pet { Available }
Source files referencing Pet.Available as defined above will have a
constant 0 in place of the enum value.
public enum Pet { Available = 1 }
Source files referencing Pet.Available as defined above will have a
constant 1 in place of the enum value.
After compilation, Pet.Available in both instances lose their semantic
values and refer to the byte representation of their integral values.
For more info, see
https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/enum
Contributor
Author
|
This PR resolves the issue present in the bug… Test case: CLI options: Evaluate: |
4 tasks
jimschubert
added a commit
to jimschubert/swagger-codegen
that referenced
this pull request
Nov 14, 2017
* master: (101 commits) [Swift4] Allow for custom dateformatter to be used (swagger-api#6672) [haskell-http-client] fix bug when generating models-only (swagger-api#6931) fix typo: crediential => credential minor typo fix [csharp] fix enum serialization of first value (swagger-api#6873) [PHP] Improve docs and README (swagger-api#6935) Binary mode for file deserialization in python (swagger-api#6936) add python tornado test to travis [Python/tornado] add integration tests and fix bugs (swagger-api#6925) Fix PHP passes response body to ApiException (swagger-api#6923) [TypeScript][Node] Resolve TS2532 error (swagger-api#6932) skip "all" shell script minor formatting change Fixes Issue swagger-api#6841, Map for accessing additionalProperties is generated. (swagger-api#6886) add tsloughter as owner erlang WIP: initial commit for Erlang client generator (swagger-api#6502) add back php client test Switch Travis image from MacOS to Linux (swagger-api#6937) add link to ebook [Scala] Default case class Option types to None for non-required fields (swagger-api#6790) ...
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.
PR checklist
./bin/to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.shand./bin/security/{LANG}-petstore.shif updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\.3.0.0branch for changes related to OpenAPI spec 3.0. Default:master.Description of the PR
NOTE: This is a continuation of #6851. opened separately to facilitate discussion of whether this is the best approach, and to verify that I haven't missed anything.
The EmitDefaultValue=false for string based enums will prevent the first
enum value from being serialized, because as 0 it is considered the
default.
This commit assigns an explicit numerical value to all non-integer
enums. This assignment has no effect on the
serialization/deserialization values, and only assigns the compiled
integer.
NOTE: This will have an effect of requiring recompilation of any code
that references the client/server models. This is because:
Source files referencing Pet.Available as defined above will have a
constant 0 in place of the enum value.
Source files referencing Pet.Available as defined above will have a
constant 1 in place of the enum value.
After compilation, Pet.Available in both instances lose their semantic
values and refer to the byte representation of their integral values.
For more info, see
https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/enum
/cc @mandrean
/cc @wing328 (this change is a compile-time breaking change, see above)