Enforce enum serialization policy

Altinn / app-lib-dotnet

Libraries used in Altinn Apps

BSD 3-Clause "New" or "Revised" License

9 stars 10 forks source link

Enforce enum serialization policy #729

Open HauklandJ opened 3 weeks ago

HauklandJ commented 3 weeks ago

As discovered in 2309. If an application chooses to specify JsonStringEnumConverter for JsonSerializerOptions then enums which are implemented with the default serialization behaviour will result in unexpected behaviour.

We should consider enforcing serialization rules for these enums.

ivarne commented 3 weeks ago

Go through all enums that we use for serialisation and ensure that they are annotated with JsonNumberEnumConverter so that global settings in apps don't apply
Write a test that searches all types in assemblies that have System.Text.Json.Serialization annotations specifies how to serialise enums with either string or number
Verify that swagger docs for enums actually reflects the serialisation strategy we use.

HauklandJ commented 3 days ago