Add sopSwaggerGenericToEncodingWithOpts and use it. #27
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The ToJSON Schema instance is missing an explicit definition of toEncoding, which this patch adds. The reason is that this ToJSON instance makes use of a somewhat special sopSwaggerGenericToJSONWithOpts function that is not used anywhere else and that had no counterpart for Encoding. Such a counterpart is added here.
|
Ping. Can this be merged? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
ToJSON Schemainstance is missing an explicit definition oftoEncoding. Without an explicit definition, the default definition kicks in, but the default loses ordering information of JSON object fields. This means that in resulting OpenAPI schemas, field names of JSON objects appear in essentially random order rather than the order specified in Haskell code.The reason is that this
ToJSONinstance makes use of a somewhat specialsopSwaggerGenericToJSONWithOptsfunction that is not used anywhere else and that had no counterpart forEncoding.Such a counterpart is added here.
This is a relatively ad-hoc fix. This code looks like it might benefit from additional refactoring, but if at all, I think that should probably be done in a different MR.
See also haskell-servant/servant-swagger-ui#89 which is an orthogonal problem with losing the order of fields.