Solvers JSON OpenAPI schema #2683
Merged
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
m-lord-renkse
approved these changes
May 1, 2024
fleupold
approved these changes
May 2, 2024
| #[allow(dead_code)] | ||
| pub struct OrderUid(String); | ||
|
|
||
| /// Signature bytes. | ||
| #[derive(ToSchema)] | ||
| #[schema(example = "0x0000000000000000000000000000000")] | ||
| #[schema( | ||
| example = "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" |
There was a problem hiding this comment.
Can we use proper examples not default values?
There was a problem hiding this comment.
Sure, will address it in the main PR.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
It turned out that
serde_yaml/unsafe-libyamllib, which is used in theutoipagenerator, has its own behavior with strings, which is not suitable for HEX values, making them displayed wrongly in OpenAPI renderers. Moreover, a deeper investigation showed that these particular libs are now deprecated, and other YAML-related libs are not in good shape(deprecated, alpha versions, etc.).The proposal is to switch to JSON schema since libs for this format are well-maintained and don't have any issues with weird string representation. Since the file is now automatically generated and doesn't require manual interventions, we shouldn't care about the file format. Also, JSON and YAML formats are interchangeable in OpenAPI.