Skip to content

Document that System.Text.Json ignores [EnumMember] #4127

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.

Sign up for GitHub

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
martincostello merged 2 commits into from
Sep 29, 2026
Merged

Document that System.Text.Json ignores [EnumMember] #4127

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f6f428
Document that System.Text.Json ignores [EnumMember]
RaphaelFakhri Aug 25, 2026
3812750
Shorten the enum member naming docs to upstream links
RaphaelFakhri Sep 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/configure-and-customize-swaggergen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -750,6 +750,14 @@ services.AddSwaggerGen(options =>
> [!NOTE]
> See [this GitHub issue](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/2703) for support for nested types.

## Rename Enum Values in Schemas
Comment thread
martincostello marked this conversation as resolved.

The enum values in a generated schema come from the serializer, so how you rename a member depends on which serializer your
application uses:

- `System.Text.Json` does not support `[EnumMember]`. Use [`[JsonStringEnumMemberName]`](https://learn.microsoft.com/dotnet/api/system.text.json.serialization.jsonstringenummembernameattribute) instead (.NET 9 and later).
- `Newtonsoft.Json` supports [`[EnumMember]`](https://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_Converters_StringEnumConverter.htm) when you use `StringEnumConverter`.

## Override Schema for Specific Types

Out-of-the-box, Swashbuckle.AspNetCore performs a best-effort generating JSON schemas that accurately describe your request and response payloads.
Expand Down
Loading