diff --git a/docs/Facility.AspNetCore.md b/docs/Facility.AspNetCore.md index 567ee9e..d8b62b0 100644 --- a/docs/Facility.AspNetCore.md +++ b/docs/Facility.AspNetCore.md @@ -4,10 +4,11 @@ | public type | description | | --- | --- | -| class [FacilityActionFilter](./Facility.AspNetCore/FacilityActionFilter.md) | | +| class [FacilityActionFilter](./Facility.AspNetCore/FacilityActionFilter.md) | Supports Facility types in controller actions (including code-generated controllers). | | static class [FacilityAspNetCoreExtensions](./Facility.AspNetCore/FacilityAspNetCoreExtensions.md) | ASP.NET Core extension methods for Facility. | | class [FacilityAspNetCoreMiddleware<T>](./Facility.AspNetCore/FacilityAspNetCoreMiddleware-1.md) | ASP.NET Core middleware for a Facility service HTTP handler. | -| class [FacilityAspNetCoreUtility](./Facility.AspNetCore/FacilityAspNetCoreUtility.md) | | -| class [FacilityExceptionHandlerOptions](./Facility.AspNetCore/FacilityExceptionHandlerOptions.md) | | +| class [FacilityAspNetCoreUtility](./Facility.AspNetCore/FacilityAspNetCoreUtility.md) | Utility methods for using Facility with ASP.NET Core. | +| class [FacilityEndpointFilter](./Facility.AspNetCore/FacilityEndpointFilter.md) | Supports Facility types returned from API routes (`ServiceResult` and `ServiceError`). | +| class [FacilityExceptionHandlerOptions](./Facility.AspNetCore/FacilityExceptionHandlerOptions.md) | Options for `FacilityAspNetCoreExtensions.UseFacilityExceptionHandler`. | diff --git a/docs/Facility.AspNetCore/FacilityActionFilter.md b/docs/Facility.AspNetCore/FacilityActionFilter.md index 8d70a6d..980de7c 100644 --- a/docs/Facility.AspNetCore/FacilityActionFilter.md +++ b/docs/Facility.AspNetCore/FacilityActionFilter.md @@ -1,5 +1,7 @@ # FacilityActionFilter class +Supports Facility types in controller actions (including code-generated controllers). + ```csharp [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true)] public sealed class FacilityActionFilter : ActionFilterAttribute diff --git a/docs/Facility.AspNetCore/FacilityAspNetCoreUtility.md b/docs/Facility.AspNetCore/FacilityAspNetCoreUtility.md index c92e37a..d5eaf97 100644 --- a/docs/Facility.AspNetCore/FacilityAspNetCoreUtility.md +++ b/docs/Facility.AspNetCore/FacilityAspNetCoreUtility.md @@ -1,5 +1,7 @@ # FacilityAspNetCoreUtility class +Utility methods for using Facility with ASP.NET Core. + ```csharp public sealed class FacilityAspNetCoreUtility ``` @@ -9,9 +11,9 @@ public sealed class FacilityAspNetCoreUtility | name | description | | --- | --- | | [FacilityAspNetCoreUtility](FacilityAspNetCoreUtility/FacilityAspNetCoreUtility.md)() | The default constructor. | -| static [CreateHttpRequestMessage](FacilityAspNetCoreUtility/CreateHttpRequestMessage.md)(…) | | -| static [CreateHttpResponseMessage](FacilityAspNetCoreUtility/CreateHttpResponseMessage.md)(…) | (2 methods) | -| static [WriteHttpResponseMessageAsync](FacilityAspNetCoreUtility/WriteHttpResponseMessageAsync.md)(…) | | +| static [CreateHttpRequestMessage](FacilityAspNetCoreUtility/CreateHttpRequestMessage.md)(…) | Converts an `HttpRequest` to an `HttpRequestMessage`. | +| static [CreateHttpResponseMessage](FacilityAspNetCoreUtility/CreateHttpResponseMessage.md)(…) | Creates an `HttpResponseMessage` for an exception. (2 methods) | +| static [WriteHttpResponseMessageAsync](FacilityAspNetCoreUtility/WriteHttpResponseMessageAsync.md)(…) | Writes an `HttpResponseMessage` to an `HttpResponse`. | ## See Also diff --git a/docs/Facility.AspNetCore/FacilityAspNetCoreUtility/CreateHttpRequestMessage.md b/docs/Facility.AspNetCore/FacilityAspNetCoreUtility/CreateHttpRequestMessage.md index fabf4b6..eab7d4f 100644 --- a/docs/Facility.AspNetCore/FacilityAspNetCoreUtility/CreateHttpRequestMessage.md +++ b/docs/Facility.AspNetCore/FacilityAspNetCoreUtility/CreateHttpRequestMessage.md @@ -1,5 +1,7 @@ # FacilityAspNetCoreUtility.CreateHttpRequestMessage method +Converts an `HttpRequest` to an `HttpRequestMessage`. + ```csharp public static HttpRequestMessage CreateHttpRequestMessage(HttpRequest httpRequest) ``` diff --git a/docs/Facility.AspNetCore/FacilityAspNetCoreUtility/CreateHttpResponseMessage.md b/docs/Facility.AspNetCore/FacilityAspNetCoreUtility/CreateHttpResponseMessage.md index 0aeb06d..8e77824 100644 --- a/docs/Facility.AspNetCore/FacilityAspNetCoreUtility/CreateHttpResponseMessage.md +++ b/docs/Facility.AspNetCore/FacilityAspNetCoreUtility/CreateHttpResponseMessage.md @@ -1,5 +1,7 @@ # FacilityAspNetCoreUtility.CreateHttpResponseMessage method (1 of 2) +Creates an `HttpResponseMessage` for an exception. + ```csharp public static HttpResponseMessage CreateHttpResponseMessage(Exception exception, HttpContentSerializer contentSerializer) @@ -14,6 +16,8 @@ public static HttpResponseMessage CreateHttpResponseMessage(Exception exception, # FacilityAspNetCoreUtility.CreateHttpResponseMessage method (2 of 2) +Creates an `HttpResponseMessage` for an error. + ```csharp public static HttpResponseMessage CreateHttpResponseMessage(ServiceErrorDto error, HttpContentSerializer contentSerializer) diff --git a/docs/Facility.AspNetCore/FacilityAspNetCoreUtility/WriteHttpResponseMessageAsync.md b/docs/Facility.AspNetCore/FacilityAspNetCoreUtility/WriteHttpResponseMessageAsync.md index 1105b4a..e5d3abf 100644 --- a/docs/Facility.AspNetCore/FacilityAspNetCoreUtility/WriteHttpResponseMessageAsync.md +++ b/docs/Facility.AspNetCore/FacilityAspNetCoreUtility/WriteHttpResponseMessageAsync.md @@ -1,5 +1,7 @@ # FacilityAspNetCoreUtility.WriteHttpResponseMessageAsync method +Writes an `HttpResponseMessage` to an `HttpResponse`. + ```csharp public static Task WriteHttpResponseMessageAsync(HttpResponseMessage httpResponseMessage, HttpResponse contextResponse) diff --git a/docs/Facility.AspNetCore/FacilityEndpointFilter.md b/docs/Facility.AspNetCore/FacilityEndpointFilter.md new file mode 100644 index 0000000..499ec13 --- /dev/null +++ b/docs/Facility.AspNetCore/FacilityEndpointFilter.md @@ -0,0 +1,21 @@ +# FacilityEndpointFilter class + +Supports Facility types returned from API routes (`ServiceResult` and `ServiceError`). + +```csharp +public sealed class FacilityEndpointFilter : IEndpointFilter +``` + +## Public Members + +| name | description | +| --- | --- | +| [FacilityEndpointFilter](FacilityEndpointFilter/FacilityEndpointFilter.md)() | The default constructor. | +| [InvokeAsync](FacilityEndpointFilter/InvokeAsync.md)(…) | | + +## See Also + +* namespace [Facility.AspNetCore](../Facility.AspNetCore.md) +* [FacilityEndpointFilter.cs](https://github.com/FacilityApi/FacilityAspNet/tree/master/src/Facility.AspNetCore/FacilityEndpointFilter.cs) + + diff --git a/docs/Facility.AspNetCore/FacilityEndpointFilter/FacilityEndpointFilter.md b/docs/Facility.AspNetCore/FacilityEndpointFilter/FacilityEndpointFilter.md new file mode 100644 index 0000000..75b62b4 --- /dev/null +++ b/docs/Facility.AspNetCore/FacilityEndpointFilter/FacilityEndpointFilter.md @@ -0,0 +1,14 @@ +# FacilityEndpointFilter constructor + +The default constructor. + +```csharp +public FacilityEndpointFilter() +``` + +## See Also + +* class [FacilityEndpointFilter](../FacilityEndpointFilter.md) +* namespace [Facility.AspNetCore](../../Facility.AspNetCore.md) + + diff --git a/docs/Facility.AspNetCore/FacilityEndpointFilter/InvokeAsync.md b/docs/Facility.AspNetCore/FacilityEndpointFilter/InvokeAsync.md new file mode 100644 index 0000000..ff45e09 --- /dev/null +++ b/docs/Facility.AspNetCore/FacilityEndpointFilter/InvokeAsync.md @@ -0,0 +1,13 @@ +# FacilityEndpointFilter.InvokeAsync method + +```csharp +public ValueTask InvokeAsync(EndpointFilterInvocationContext context, + EndpointFilterDelegate next) +``` + +## See Also + +* class [FacilityEndpointFilter](../FacilityEndpointFilter.md) +* namespace [Facility.AspNetCore](../../Facility.AspNetCore.md) + + diff --git a/docs/Facility.AspNetCore/FacilityExceptionHandlerOptions.md b/docs/Facility.AspNetCore/FacilityExceptionHandlerOptions.md index 7e7ae4d..6fa911d 100644 --- a/docs/Facility.AspNetCore/FacilityExceptionHandlerOptions.md +++ b/docs/Facility.AspNetCore/FacilityExceptionHandlerOptions.md @@ -1,5 +1,7 @@ # FacilityExceptionHandlerOptions class +Options for `FacilityAspNetCoreExtensions.UseFacilityExceptionHandler`. + ```csharp public sealed class FacilityExceptionHandlerOptions ``` @@ -9,8 +11,8 @@ public sealed class FacilityExceptionHandlerOptions | name | description | | --- | --- | | [FacilityExceptionHandlerOptions](FacilityExceptionHandlerOptions/FacilityExceptionHandlerOptions.md)() | The default constructor. | -| [ContentSerializer](FacilityExceptionHandlerOptions/ContentSerializer.md) { get; set; } | | -| [IncludeErrorDetails](FacilityExceptionHandlerOptions/IncludeErrorDetails.md) { get; set; } | | +| [ContentSerializer](FacilityExceptionHandlerOptions/ContentSerializer.md) { get; set; } | The content serializer to use when writing an error to the response. | +| [IncludeErrorDetails](FacilityExceptionHandlerOptions/IncludeErrorDetails.md) { get; set; } | True to include error details. Not for production. | ## See Also diff --git a/docs/Facility.AspNetCore/FacilityExceptionHandlerOptions/ContentSerializer.md b/docs/Facility.AspNetCore/FacilityExceptionHandlerOptions/ContentSerializer.md index 2e45905..699715c 100644 --- a/docs/Facility.AspNetCore/FacilityExceptionHandlerOptions/ContentSerializer.md +++ b/docs/Facility.AspNetCore/FacilityExceptionHandlerOptions/ContentSerializer.md @@ -1,5 +1,7 @@ # FacilityExceptionHandlerOptions.ContentSerializer property +The content serializer to use when writing an error to the response. + ```csharp public HttpContentSerializer? ContentSerializer { get; set; } ``` diff --git a/docs/Facility.AspNetCore/FacilityExceptionHandlerOptions/IncludeErrorDetails.md b/docs/Facility.AspNetCore/FacilityExceptionHandlerOptions/IncludeErrorDetails.md index 5cab38f..2b1f554 100644 --- a/docs/Facility.AspNetCore/FacilityExceptionHandlerOptions/IncludeErrorDetails.md +++ b/docs/Facility.AspNetCore/FacilityExceptionHandlerOptions/IncludeErrorDetails.md @@ -1,5 +1,7 @@ # FacilityExceptionHandlerOptions.IncludeErrorDetails property +True to include error details. Not for production. + ```csharp public bool IncludeErrorDetails { get; set; } ```