search

haskell-servant / servant-swagger-ui

Provide embedded swagger UI for servant and swagger
46 stars 34 forks source link

Force lexicographic ordering on swagger json. #98

Closed fisx closed 2 years ago

fisx commented 2 years ago

The orderings of end-points and definitions are taken from the serialized json object. Lexicographic may not always be what you would want, but it is better than what we have now, which in the case of old aeson renderings based in HashMap is completely random.

The only downside I can see is performance, which really shouldn't be an issue on this end-point.

One question remains whether I should export PrettyJSON. It doesn't really belong here, but we are exporting type aliases that make use of it, so some sophisticated uses may be blocked if we don't.

fisx commented 2 years ago

Ready! I think I still have the power to merge, but I feel somebody more involved should make the call?

fisx commented 2 years ago

Never mind, we upgraded to the latest version of swagger-ui and aeson, and that puts things in lexicographical order without this change. I haven't investigated, but I think it's safe to say this is unnecessary now?