Use sorted properties when saving configuration in NSwagStudio

[lahma]

It's quite annoying to see all JSON properties jumping around when saving new version of nswag.json (migrating from v13 to v14). We could introduce a one time breaking change which will make Studio save file following ordered JSON property names so that later VCS diffs etc would look nicer.

Included change for NSwag.Sample.NET80/nswag.json which shows how obsolete properties are removed and they are now sorted correctly after save via NSwagStudio.

[lahma]

Couldn't find a property UseDocumentProvider anywhere so this seemed unnecessary

[RicoSuter]

I think this is gone, correct

[RicoSuter]

Can't you just update the nswag.json with the new version and then the props should be stable as the order in c# stays? Do we really need reorder? I think alpha order is not optimal as the props which belong together are shuffled...

[lahma]

Hmm so this has changed in NET 7 that you could get the properties in same order every time even with reflection, before it was not guaranteed:

https://learn.microsoft.com/en-us/dotnet/api/system.type.getproperties?view=net-7.0

In .NET 6 and earlier versions, the GetProperties method does not return properties in a particular order, such as alphabetical or declaration order. Your code must not depend on the order in which properties are returned, because that order varies. However, starting with .NET 7, the ordering is deterministic based upon the metadata ordering in the assembly.

I'm more of a alphabetical guy myself. I like to see all ignoreXXX, includeXXX, excludeXXX kind of properties list together so I can explore all the things I can use to for example include and exclude and then flip the switches which are nicely grouped together. But I do understand the sentiment to have the in some other order too.