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

SwaggerSchemaFilterAttribute #445

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,20 +1,34 @@
using System;
using System.Linq;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web.Http.Description;

namespace Swashbuckle.Swagger.Annotations
{
public class ApplySwaggerSchemaFilterAttributes : ISchemaFilter
{
public void Apply(Schema schema, SchemaRegistry schemaRegistry, Type type)
{
var attributes = type.GetCustomAttributes(false).OfType<SwaggerSchemaFilterAttribute>();
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't simply changing the "inherit" flag to true in the call to GetCustomAttributes satisfy this requirement. I just tried it out and it appears to work. No need for all the code below.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The point of the additional code was to apply filters in the correct order. Just using true gets attributes in order derived class -> base class.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does ordering really matter? If there's a specific use-case I might be willing to make the trade-off (i.e. introducing more complex code), otherwise I'd just opt for the simple solution


foreach (var attribute in attributes)
{
var filter = (ISchemaFilter)Activator.CreateInstance(attribute.FilterType);
filter.Apply(schema, schemaRegistry, type);
}
{
// create list of base types
Stack<Type> types = new Stack<Type>();
types.Push(type);

Type t;
while ((t = types.Peek().BaseType) != null)
{
types.Push(t);
}

// walk attributes in order base-type -> child-type
// GetCustomAttributes(inherit: true) walks types in opposite direction and simple reverse would not suffice if multiple attributes are applied
while (types.Count > 0)
{
foreach (SwaggerSchemaFilterAttribute attribute in types.Pop().GetCustomAttributes(typeof(SwaggerSchemaFilterAttribute), false))
{
var filter = (ISchemaFilter)Activator.CreateInstance(attribute.FilterType);
filter.Apply(schema, schemaRegistry, type);
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace Swashbuckle.Swagger.Annotations
{
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
public class SwaggerSchemaFilterAttribute : Attribute
{
public SwaggerSchemaFilterAttribute(Type filterType)
Expand Down