Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parameter Description Should Default to Parameter Descriptor Documentation #1101

Open
commonsensesoftware opened this issue Jun 5, 2017 · 0 comments

Comments

@commonsensesoftware
Copy link

An operation parameter.description never contains a default description even though one might be provided by ApiParameterDescription.Documenation might provide one. In most cases, the description will come from XML comments, but not necessarily always.

The description should use the default value provided as so in the SwaggerGenerator.cs:

parameter.description = paramDesc.Documentation;

Although not 100% required, it is probably worth updating ApplyXmlActionComments.cs so that the description is only updated when there is a parameter XML node with a non-empty value.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant