Added YAML Support to Examples#185
Open
adam8797 wants to merge 4 commits into
Open
Conversation
Owner
|
Looks good so far, nice one. I can't say I've ever seen an API which returned YAML so it seems like an edge case to need examples in YAML. Could you add some tests? |
Author
|
Sure thing. Just wanted to get a stamp of approval in the implementation code before I went and did the rest of that work. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I've added support for sending back YAML examples if the application supports it.
I've also gone and encapsulated the logic around the individual formats, instead of checking the type in the rendering methods
One of the things that bugs me about this is that YAML is whitespace sensitive, and in order to actually get it to render properly in the document we have to render it as an
OpenApiStringand let the framework add newlines for us.Existing tests pass, but I haven't added new tests or examples yet.