Skip to content

Commit 74ac847

Browse files
authored
Update README.md
Signed-off-by: Eric Sibly [chullybun] <[email protected]>
1 parent 13b4aca commit 74ac847

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/CoreEx.AspNetCore/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ Fire-and-forget | This is to enable decoupled asynchronous processing, whereby t
1717

1818
## Limitations
1919

20-
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.
20+
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.
21+
22+
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.
2123

2224
<br/>
2325

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

79+
As described earlier, the above will _not_ occur for `IActionResult` results.
80+
7781
<br/>
7882

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

0 commit comments

Comments
 (0)