Skip to content

Commit

Permalink
[Doc] Doc updated
Browse files Browse the repository at this point in the history
  • Loading branch information
JeremyBP committed Nov 22, 2024
1 parent 29eef82 commit 3320db1
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 7 deletions.
3 changes: 2 additions & 1 deletion Apizr/Docs/Apizr.Docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
- [New][Authentication] Now **`WithAuthenticationHandler` option provide many more overloads** to fit more use cases, like property mapping, local methods, service methods, custom handler, etc.
- [New][Authentication] Now **`AuthenticationHandlerBase` does clone request Options** as well as former Properties
- [New][Authentication] Now **`AuthenticationHandlerBase` performances and behavior have been improved** by caching compiled factories and adjusting authentication flow
- [Improvement/Breaking][Authentication] Now **`AuthenticationHandlerBase` with no token available fails fast by returning an Unauthorized response** without actually sending the request
- [Improvement][Authentication] Now **`AuthenticationHandlerBase` with no token available fails fast by returning an Unauthorized response** without actually sending the request
- [Improvement/Fix][Authentication] Now **`AuthenticationHandlerBase` does not clone anymore request with multipart content** to prevent from memory leaks and stream issues
- [Improvement/Breaking][Authentication] Now **`AuthenticationHandlerBase`'s GetToken & SetToken former methods upgraded to GetTokenAsync & SetTokenAsync** so we could wait for it
- [Improvement/Breaking][Authentication] Now **`WithAuthenticationHandler` option's methods handle more parameters** like HttpRequestMessage & CancellationToken
- [Breaking][DelegatingHandler] Now **`WithDelegatingHandler`, `WithHttpMessageHandler` and `WithAuthenticationHandler` provide a Logger within IApizrManagerOptionsBase single parameter**
Expand Down
16 changes: 15 additions & 1 deletion Apizr/Samples/Apizr.Sample.MAUI/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"ShouldInvalidateOnError": false
}
},
"IReqResService": {
"IReqResUserService": {
"Caching": {
"Mode": "FetchOrGet",
"LifeSpan": "00:12:00",
Expand All @@ -49,6 +49,20 @@
"HttpGet": [ "TestPipeline3" ]
}
},
"IReqResSimpleService": {
"BaseAddress": "https://reqres.in/api",
"RequestTimeout": "00:00:03",
"Headers": [
"testSettingsKey2: testSettingsValue2.1",
"testSettingsKey3: *testSettingsValue3.1*",
"testSettingsKey4: {0}",
"testSettingsKey5: *{0}*"
],
"ResiliencePipelineOptions": {
"HttpGet": [ "TestPipeline3" ]
}
//"ResiliencePipelineKeys": [ "TestPipeline3" ]
},
"IHttpBinService": {
"BaseAddress": "https://httpbin.org",
"RequestTimeout": "00:00:04",
Expand Down
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
- [New][Authentication] Now **`WithAuthenticationHandler` option provide many more overloads** to fit more use cases, like property mapping, local methods, service methods, custom handler, etc.
- [New][Authentication] Now **`AuthenticationHandlerBase` does clone request Options** as well as former Properties
- [New][Authentication] Now **`AuthenticationHandlerBase` performances and behavior have been improved** by caching compiled factories and adjusting authentication flow
- [Improvement/Breaking][Authentication] Now **`AuthenticationHandlerBase` with no token available fails fast by returning an Unauthorized response** without actually sending the request
- [Improvement][Authentication] Now **`AuthenticationHandlerBase` with no token available fails fast by returning an Unauthorized response** without actually sending the request
- [Improvement/Fix][Authentication] Now **`AuthenticationHandlerBase` does not clone anymore request with multipart content** to prevent from memory leaks and stream issues
- [Improvement/Breaking][Authentication] Now **`AuthenticationHandlerBase`'s GetToken & SetToken former methods upgraded to GetTokenAsync & SetTokenAsync** so we could wait for it
- [Improvement/Breaking][Authentication] Now **`WithAuthenticationHandler` option's methods handle more parameters** like HttpRequestMessage & CancellationToken
- [Breaking][DelegatingHandler] Now **`WithDelegatingHandler`, `WithHttpMessageHandler` and `WithAuthenticationHandler` provide a Logger within IApizrManagerOptionsBase single parameter**
Expand Down
2 changes: 1 addition & 1 deletion docs/articles/config_transfer.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ <h3 id="installing">Installing</h3>
</tbody>
</table>
<h3 id="designing">Designing</h3>
<p>File Transfer package comes with some built-in apis son you don't have to create it yourself.</p>
<p>File Transfer package comes with some built-in apis so you don't have to create it yourself.</p>
<p>Here is what the provided apis look like then:</p>
<div class="tabGroup" id="tabgroup_1">
<ul role="tablist">
Expand Down
3 changes: 2 additions & 1 deletion docs/changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ <h3 id="all">All</h3>
<li>[New][Authentication] Now <strong><code>WithAuthenticationHandler</code> option provide many more overloads</strong> to fit more use cases, like property mapping, local methods, service methods, custom handler, etc.</li>
<li>[New][Authentication] Now <strong><code>AuthenticationHandlerBase</code> does clone request Options</strong> as well as former Properties</li>
<li>[New][Authentication] Now <strong><code>AuthenticationHandlerBase</code> performances and behavior have been improved</strong> by caching compiled factories and adjusting authentication flow</li>
<li>[Improvement/Breaking][Authentication] Now <strong><code>AuthenticationHandlerBase</code> with no token available fails fast by returning an Unauthorized response</strong> without actually sending the request</li>
<li>[Improvement][Authentication] Now <strong><code>AuthenticationHandlerBase</code> with no token available fails fast by returning an Unauthorized response</strong> without actually sending the request</li>
<li>[Improvement/Fix][Authentication] Now <strong><code>AuthenticationHandlerBase</code> does not clone anymore request with multipart content</strong> to prevent from memory leaks and stream issues</li>
<li>[Improvement/Breaking][Authentication] Now <strong><code>AuthenticationHandlerBase</code>'s GetToken &amp; SetToken former methods upgraded to GetTokenAsync &amp; SetTokenAsync</strong> so we could wait for it</li>
<li>[Improvement/Breaking][Authentication] Now <strong><code>WithAuthenticationHandler</code> option's methods handle more parameters</strong> like HttpRequestMessage &amp; CancellationToken</li>
<li>[Breaking][DelegatingHandler] Now <strong><code>WithDelegatingHandler</code>, <code>WithHttpMessageHandler</code> and <code>WithAuthenticationHandler</code> provide a Logger within IApizrManagerOptionsBase single parameter</strong></li>
Expand Down
Loading

0 comments on commit 3320db1

Please sign in to comment.