docs: comments for DefaultActionFilter and DefaultTypeFilter

Author: maurei

src/JsonApiDotNetCore/Middleware/JsonApiExceptionFilter.cs renamed to src/JsonApiDotNetCore/Middleware/DefaultExceptionFilter.cs

@@ -1,21 +1,13 @@
-using System;
-using JsonApiDotNetCore.Internal;
+using JsonApiDotNetCore.Internal;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;
 using Microsoft.Extensions.Logging;
 
 namespace JsonApiDotNetCore.Middleware
 {
- public interface IJsonApiExceptionFilterProvider
- {
- Type Get();
- }
-
- public class JsonApiExceptionFilterProvider : IJsonApiExceptionFilterProvider
- {
- public Type Get() => typeof(DefaultExceptionFilter);
- }
-
+ /// <summary>
+ /// Global exception filter that wraps any thrown error with a JsonApiException.
+ /// </summary>
  public class DefaultExceptionFilter : ActionFilterAttribute, IExceptionFilter
  {
  private readonly ILogger _logger;

src/JsonApiDotNetCore/Middleware/TypeMatchFilter.cs renamed to src/JsonApiDotNetCore/Middleware/DefaultTypeMatchFilter.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Linq;
 using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Internal.Contracts;
@@ -7,28 +7,18 @@
 
 namespace JsonApiDotNetCore.Middleware
 {
- public interface IJsonApiTypeMatchFilterProvider
- {
- Type Get();
- }
-
- public class JsonApiTypeMatchFilterProvider : IJsonApiTypeMatchFilterProvider
- {
- public Type Get() => typeof(TypeMatchFilter);
- }
-
- public class TypeMatchFilter : IActionFilter
+ /// <summary>
+ /// Action filter used to verify the incoming type matches the target type, else return a 409
+ /// </summary>
+ public class DefaultTypeMatchFilter : IActionFilter
  {
  private readonly IContextEntityProvider _provider;
 
- public TypeMatchFilter(IContextEntityProvider provider)
+ public DefaultTypeMatchFilter(IContextEntityProvider provider)
  {
  _provider = provider;
  }
 
- /// <summary>
- /// Used to verify the incoming type matches the target type, else return a 409
- /// </summary>
  public void OnActionExecuting(ActionExecutingContext context)
  {
  var request = context.HttpContext.Request;

src/JsonApiDotNetCore/Middleware/IJsonApiExceptionFilterProvider.cs

@@ -0,0 +1,20 @@
+using System;
+
+namespace JsonApiDotNetCore.Middleware
+{
+ /// <summary>
+ /// Provides the type of the global exception filter that is configured in MVC during startup.
+ /// This can be overridden to let JADNC use your own exception filter. The default exception filter used
+ /// is <see cref="DefaultExceptionFilter"/>
+ /// </summary>
+ public interface IJsonApiExceptionFilterProvider
+ {
+ Type Get();
+ }
+
+ /// <inheritdoc/>
+ public class JsonApiExceptionFilterProvider : IJsonApiExceptionFilterProvider
+ {
+ public Type Get() => typeof(DefaultExceptionFilter);
+ }
+}

src/JsonApiDotNetCore/Middleware/IJsonApiTypeMatchFilterProvider.cs

@@ -0,0 +1,20 @@
+using System;
+
+namespace JsonApiDotNetCore.Middleware
+{
+ /// <summary>
+ /// Provides the type of the global action filter that is configured in MVC during startup.
+ /// This can be overridden to let JADNC use your own exception filter. The default exception filter used
+ /// is <see cref="DefaultTypeMatchFilter"/>
+ /// </summary>
+ public interface IJsonApiTypeMatchFilterProvider
+ {
+ Type Get();
+ }
+
+ /// <inheritdoc/>
+ public class JsonApiTypeMatchFilterProvider : IJsonApiTypeMatchFilterProvider
+ {
+ public Type Get() => typeof(DefaultTypeMatchFilter);
+ }
+}