Added Swashbuckle.AspNetCore.Annotations.SwaggerIgnoreAttribute

[jcracknell]

Application of the SwaggerIgnoreAttribute suppresses the annotated property during schema generation, without altering the serialization behavior as with JsonIgnoreAttribute.

This is useful in a scenario where you want to capture and reject unhandled properties, without advertising that you accept additionalProperties (which is the opposite of what is intended):

public abstract class RequestBase : IValidatableObject {
    [SwaggerIgnore]
    [JsonExtensionData]
    public IDictionary<string, JsonElement>? UnsupportedProperties { get; set; }

    public virtual IEnumerable<ValidationResult> Validate(ValidationContext validationContext) {
        if(UnsupportedProperties is { Count: not 0 })
            foreach(var entry in UnsupportedProperties)
                yield return new ValidationResult($"Unsupported property: {entry.Key}.", new[] { entry.Key });
    }
}

I added the annotation to the Swashbuckle.AspNetCore.SwaggerGen project as it is much easier to filter the properties in the JsonSerializerDataContractResolver than after the fact in a filter, as you would need to regenerate the data contract for the type and then remove all of the annotated properties and derived side effects.

[Havunen]

Maybe the attribute should be called something else from "ignore" ie. SwaggerHiddenAttribute to indicate it is not the same thing.

[martincostello]

Thanks for contributing - if you'd like to continue with this pull request, please rebase against the default branch to pick up our new CI.

[jcracknell]

Done. I've also added commits to support the attribute on operations and parameters.

I'm aware of the current recommended approach of excluding methods using ApiExplorerSettingsAttribute, but there's something to be said for consistency, and there's also a difference between excluding the operation from Swashbuckle and excluding it from the ApiExplorer.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.78%. Comparing base (572bc32) to head (58e04b8).
Report is 1 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2610   +/-   ##
=======================================
  Coverage   91.78%   91.78%           
=======================================
  Files          91       91           
  Lines        3042     3045    +3     
  Branches      521      521           
=======================================
+ Hits         2792     2795    +3     
  Misses        250      250           

Flag	Coverage Δ
Linux	91.78% <100.00%> (+<0.01%)	⬆️
Windows	91.78% <100.00%> (+<0.01%)	⬆️
macOS	91.78% <100.00%> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jcracknell]

You're correct that PropertyInfo.HasAttribute is public API and dropping it would be a breaking change, so I've dropped the commit. Unfortunately it's also going to be highly infectious thanks to Intellisense, so I'd suggest marking it as obsolete so people are aware, but I'll leave that up to you.

I've also dropped the commit adding extensions on Api{,Parameter}Description, as I had not realized that these are ApiExplorer types, and public extension methods are inappropriate here for the same reason.

[martincostello]

Thanks for the contribution - I'm not going to merge this immediately as I'm not sure if our next release is going to be a patch release of just small changes/tweaks/fixes, or a minor release with some new features too (like this).

Once we know the next release is going to be minor (or major), I'll merge this.