Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Eric Sibly [chullybun] <[email protected]>
  • Loading branch information
chullybun authored Jan 24, 2024
1 parent 13b4aca commit 74ac847
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions src/CoreEx.AspNetCore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ Fire-and-forget | This is to enable decoupled asynchronous processing, whereby t

## Limitations

Only JSON-based Web APIs are supported. Where additional or other content types are needed then this library in its current state will not be able to enable, and these Web APIs will need to be implemented in a traditional custom manner.
Only JSON-based Web APIs are generally supported. Where additional or other content types are needed then this library in its current state will not be able to enable, and these Web APIs will need to be implemented in a traditional custom manner.

There is provision such that any result of type [`IActionResult`](https://learn.microsoft.com/en-us/aspnet/core/web-api/action-return-types), for example [`FileContentResult`](https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.mvc.filecontentresult), is returned these will be enacted by the ASP.NET Core runtime as-is (i.e. no `CoreEx.AspNetCore` processing will occur on the result). However, all other request handling, exception handling, logging, etc. described below will occur which has a consistency benefit.

<br/>

Expand Down Expand Up @@ -74,6 +76,8 @@ JSON serialization | Serializes the `TResult` value using the `IJsonSerailizer`.
[Status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) | Sets the response HTTP status code as configured.
[`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location) | Sets the HTTP `Location` header where specified (applicable).

As described earlier, the above will _not_ occur for `IActionResult` results.

<br/>

### ASP.NET example
Expand Down Expand Up @@ -217,4 +221,4 @@ public class HttpTriggerQueueVerificationFunction
[FunctionName(nameof(HttpTriggerQueueVerificationFunction))]
public Task<IActionResult> RunAsync([HttpTrigger(AuthorizationLevel.Function, "post", Route = "employee/verify")] HttpRequest request)
=> _webApiPublisher.PublishAsync(request, _settings.VerificationQueueName, validator: new EmployeeVerificationValidator().Wrap());
```
```

0 comments on commit 74ac847

Please sign in to comment.