[BUG][csharp] Fix integer/numeric enum JSON converters using string operations instead of numeric
- Analyze the issue: C# generichost enum JSON converters always use string operations even for integer enums
- Fix
modelEnum.mustache— enum's own converter Read/Write handles numeric types correctly - Fix
JsonConverter.mustache— model property enum Read delegates toJsonSerializer.Deserialize<EnumType>() - Fix
JsonConverter.mustache— WriteNumber path usesValueConverter.ToJsonValue()for non-inner enums - Fix
AbstractCSharpCodegen.java— propagate numeric flags from enum models to properties (but NOT isString, which breaks anyOf models) - Add
EnumJsonReaderMethod.mustachepartial - Fix double/float/decimal enum handling with switch-case
ToJsonValue - Fix nullable enum converters (WriteNullValue, JsonTokenType.Null check)
- Emit
: longfor int64 enum declarations - Regenerate all affected sample files (47 configs)
- All tests pass with no regressions
Original prompt
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
Enums are always generated to be strings. Even when the type is integer. This generates code like
public static MyEnum? FromStringOrDefault(string value) { if (value.Equals((0).ToString())) return MyEnum.None; if (value.Equals((1).ToString())) return MyEnum.Some; return null; }which is on one hand silly, on the other this actually causes fatal issues.
openapi-generator version
docker:
openapitools/openapi-generator-cli:v7.14.0@sha256:a620610d9fabf7ce05310c648417ba168125aac2f4517580030e115921ac1a52OpenAPI declaration file content or url
Openapi spec
{ "openapi": "3.0.1", "info": { "title": "Example", "version": "v1" }, "paths": { "/some/api": { "get": { "tags": [ "Example" ], "description": "", "operationId": "ExampleApi", "responses": { "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/MyEnum" } } } } } } } }, "components": { "schemas": { "MyEnum": { "enum": [ 0, 1 ], "type": "integer", "description": "description", "format": "int32", "x-enum-varnames": [ "None", "Some" ], "x-enum-descriptions": [ "This is none", "this is some" ] } } }, "tags": [ { "name": "Example" } ] }Generation Details
docker run --rm -v "${PWD}":/local openapitools/openapi-generator-cli:v7.14.0@sha256:a620610d9fabf7ce05310c648417ba168125aac2f4517580030e115921ac1a52 generate -i /local/openapi.json -g csharp -o /local/artifacts/outSteps to reproduce
create the above json and run the above command
Related issues/PRs
https://github.com/OpenAPITools/openapi-generator/issues/21204
https://github.com/OpenAPITools/openapi-generator/issues/15204
https://github.com/OpenAPITools/openapi-generator/issues/8458at this point I stopped looking
Actual vs expected
The spec describes an integer enum, the code handles it like a string. Since the default c# mode is
generichostwhich usesSystem.Text.Json, it usesUtf8JsonReaderand for very low level optimisation reason the reader differentiates string values from number values.The problematic code is in
MyEnumJsonConverterwhich does:public override MyEnum Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { string? rawValue = reader.GetString(); // <--- this line throws exception MyEnum? result = rawValue == null ? null : MyEnumValueConverter.FromStringOrDefault(rawValue); if (result != null) return result.Value; throw new JsonException(); }the exception:
System.InvalidOperationException: Cannot get the value of a token type 'Number' as a string. at System.Text.Json.ThrowHelper.ThrowInvalidOperationException_ExpectedString(JsonTokenType tokenType) at System.Text.Json.Utf8JsonReader.GetString()The same principle applies to the
Writemethod. It gets written as a string, which violates the spec!Suggest a fix
The generator should respect the
"type": "integer"in the openapi spec and handle the underlying type as such.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.