Deprecate example field #1637
Merged
Deprecate example field #1637
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 example field using google.protobuf.Any was pretty silly and just happened to work because of how we were using it. It's confusing to users and breaks some tooling, so it is best deprecated. This is an unfortunate break from the "each field maps to the openapiv2 schema" precedent we've maintained so far, but there is no other good way that I can think of to safely deprecate this.
johanbrandhorst
force-pushed
the
deprecate-example-field
branch
from
8c40ef7 to
d7add58
Compare
ivucica
reviewed
Sep 8, 2020
|
There is no diff in the swagger examples because the output is exactly the same as before. |
|
After writing my comment, I took an even closer look at the source code --
I see that it's still putting the output into 'example' field.
Thank you for doing this!
|
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 example field using google.protobuf.Any
was pretty silly and just happened to work because
of how we were using it. It's confusing to users and breaks some tooling,
so it is best deprecated.
This is an unfortunate break from the "each field maps to the openapiv2 schema"
precedent we've maintained so far, but there is
no other good way that I can think of to safely deprecate
this.
Any thoughts @ivucica?