Allow both the summary and description from OpenAPI to be added as summary and remarks in c# generated code #4105
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
…` tag in generated c# client/controller code.
|
Thanks for the PR. |
lahma
pushed a commit
to lahma/NSwag
that referenced
this pull request
Dec 25, 2022
…` tag in generated c# client/controller code. (RicoSuter#4105) Co-authored-by: Jason Cooper <jason@codecooper.com>
lahma
pushed a commit
to lahma/NSwag
that referenced
this pull request
Jan 20, 2024
…` tag in generated c# client/controller code. (RicoSuter#4105) Co-authored-by: Jason Cooper <jason@codecooper.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.
The following changes will add the
descriptionproperty from an OpenAPI operation under the<remarks>xml comment in c# client code. Unit tests were updated to check for the annotations. My OpenAPI specs are typically quite detailed in the summary and description and and I wanted to add that documentation to the generated controllers and clients.