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.

Sign up for GitHub

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

Jump to bottom

Added ability to add parameter description attributes #552

Closed
wants to merge 3 commits into from
Closed

Added ability to add parameter description attributes #552

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54ca68d
Added ability to add parameter description attributes
jsheely Dec 8, 2017
fc39206
Evidently the value can't be null. EmptyString check
jsheely Dec 8, 2017
d9cca51
Fixed null check
jsheely Dec 8, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions src/Swashbuckle.AspNetCore.SwaggerGen/Generator/SwaggerGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
using Microsoft.AspNetCore.Mvc.ApiExplorer;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using Swashbuckle.AspNetCore.Swagger;
using System.ComponentModel;
using System.Reflection;

namespace Swashbuckle.AspNetCore.SwaggerGen
{
Expand Down Expand Up @@ -172,20 +174,23 @@ private IParameter CreateParameter(
: paramDescription.Name;

var schema = (paramDescription.Type == null) ? null : schemaRegistry.GetOrRegister(paramDescription.Type);

var description = (paramDescription.Type == null) ? null : paramDescription.Type.GetTypeInfo().GetCustomAttribute<DescriptionAttribute>();

if (location == "body")
{
return new BodyParameter
{
Name = name,
Schema = schema
Schema = schema,
Description = description?.Description
};
}

var nonBodyParam = new NonBodyParameter
{
Name = name,
In = location,
Description = description?.Description,
Required = (location == "path") || paramDescription.IsRequired()
};

Expand Down