support property example #901
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
[WHY] * the generated swagger json didn't include the example for the response [HOW] * add a new option for params description `ex` to provided example for the specific parameters
PanosCodes
suggested changes
Oct 28, 2023
There was a problem hiding this comment.
Awesome work 🚀 Thank you for working on it 🙏 example is indeed a valid swagger attribute.
Perhaps the options can be named example? Do you know if there was a reason not to do that?
spec/lib/apipie/generator/swagger/param_description/builder_spec.rb
Outdated
Show resolved
Hide resolved
Co-authored-by: Panos Dalitsouris <22100396+PanosCodes@users.noreply.github.com>
PanosCodes
suggested changes
Nov 2, 2023
Co-authored-by: Panos Dalitsouris <22100396+PanosCodes@users.noreply.github.com>
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.
[WHY]
[HOW]
exto provide an example for the specific parametersHere is a swagger editor preview with the ex option, which correctly shows the example in response:
