Do not duplicate parameter's description when there is an example, and inline the example. #1678
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
foriequal0
changed the title
foriequal0
changed the title
Parameter's descriptions are already included by `XmlCommentsParameterFilter`.
mattfrear
reviewed
Jul 2, 2020
| } | ||
| } | ||
|
|
||
| private static IOpenApiAny ConvertToOpenApiType(Type memberType, OpenApiSchema schema, string stringValue) |
There was a problem hiding this comment.
Maybe you shouldn't duplicate this method and move it somewhere so it can be used here and in XmlCommentsSchemaFilter.
domaindrivendev
force-pushed
the
master
branch
2 times, most recently
from
8e3f00c to
110bd60
Compare
domaindrivendev
force-pushed
the
master
branch
from
ac27f9e to
61b2fb2
Compare
|
I believe the underlying bug has since been resolved by some refactors to the Xml comments filters and so this PR is no longer neccessary. I'm not sure if these changes are present in the lastest stable release but they will be in the latest preview release available on myget.org. @foriequal0 if you get a chance, please try out the preview package and let me know if the duplication is in fact resolved. If it's not we'll need to create a new issue and subsequent PR. Thx |
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.
Previous PRs: #1552, #1629
Before:
{ "name": "foo", "in": "path", "description": "foo parameter", "schema": { "type": "string", "description": "foo parameter", "example": "baz" } }After removing duplication:
{ "name": "foo", "in": "path", "description": "foo parameter", "schema": { "type": "string", "example": "baz" } }After moving examples under its parameters:
{ "name": "foo", "in": "path", "description": "foo parameter", "example": "baz", "schema": { "type": "string" } }