Skip to content

Commit

Permalink
Documentation updated.
Browse files Browse the repository at this point in the history
  • Loading branch information
FacilityApiBot committed Mar 26, 2024
1 parent c081000 commit 1a04865
Show file tree
Hide file tree
Showing 12 changed files with 75 additions and 8 deletions.
7 changes: 4 additions & 3 deletions docs/Facility.AspNetCore.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`. |

<!-- DO NOT EDIT: generated by xmldocmd for Facility.AspNetCore.dll -->
2 changes: 2 additions & 0 deletions docs/Facility.AspNetCore/FacilityActionFilter.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 5 additions & 3 deletions docs/Facility.AspNetCore/FacilityAspNetCoreUtility.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# FacilityAspNetCoreUtility class

Utility methods for using Facility with ASP.NET Core.

```csharp
public sealed class FacilityAspNetCoreUtility
```
Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# FacilityAspNetCoreUtility.CreateHttpRequestMessage method

Converts an `HttpRequest` to an `HttpRequestMessage`.

```csharp
public static HttpRequestMessage CreateHttpRequestMessage(HttpRequest httpRequest)
```
Expand Down
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# FacilityAspNetCoreUtility.WriteHttpResponseMessageAsync method

Writes an `HttpResponseMessage` to an `HttpResponse`.

```csharp
public static Task WriteHttpResponseMessageAsync(HttpResponseMessage httpResponseMessage,
HttpResponse contextResponse)
Expand Down
21 changes: 21 additions & 0 deletions docs/Facility.AspNetCore/FacilityEndpointFilter.md
Original file line number Diff line number Diff line change
@@ -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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.AspNetCore.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# FacilityEndpointFilter constructor

The default constructor.

```csharp
public FacilityEndpointFilter()
```

## See Also

* class [FacilityEndpointFilter](../FacilityEndpointFilter.md)
* namespace [Facility.AspNetCore](../../Facility.AspNetCore.md)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.AspNetCore.dll -->
13 changes: 13 additions & 0 deletions docs/Facility.AspNetCore/FacilityEndpointFilter/InvokeAsync.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# FacilityEndpointFilter.InvokeAsync method

```csharp
public ValueTask<object?> InvokeAsync(EndpointFilterInvocationContext context,
EndpointFilterDelegate next)
```

## See Also

* class [FacilityEndpointFilter](../FacilityEndpointFilter.md)
* namespace [Facility.AspNetCore](../../Facility.AspNetCore.md)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.AspNetCore.dll -->
6 changes: 4 additions & 2 deletions docs/Facility.AspNetCore/FacilityExceptionHandlerOptions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# FacilityExceptionHandlerOptions class

Options for `FacilityAspNetCoreExtensions.UseFacilityExceptionHandler`.

```csharp
public sealed class FacilityExceptionHandlerOptions
```
Expand All @@ -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) { getset; } | |
| [ContentSerializer](FacilityExceptionHandlerOptions/ContentSerializer.md) { get; set; } | The content serializer to use when writing an error to the response. |
| [IncludeErrorDetails](FacilityExceptionHandlerOptions/IncludeErrorDetails.md) { getset; } | True to include error details. Not for production. |

## See Also

Expand Down
Original file line number Diff line number Diff line change
@@ -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; }
```
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# FacilityExceptionHandlerOptions.IncludeErrorDetails property

True to include error details. Not for production.

```csharp
public bool IncludeErrorDetails { get; set; }
```
Expand Down

0 comments on commit 1a04865

Please sign in to comment.