Merge pull request #144 from hmrc/BDOG-1512

BDOG-1512 Update docs
hmrc · May 19, 2022 · 6a9e8c1 · 6a9e8c1
2 parents 88ff2a6 + 61b9cb6
commit 6a9e8c1
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,9 +7,10 @@ This should not affect most clients, as long as a compatible library versions ar
 
 ## Version 13.13.0
 
-### Auditing max body length
+### Adds HttpClientV2
+This is in addition to `HttpClient` (for now), so can be optionally used instead.
 
-Payloads will be truncated in audit logs if they exceed the max supported (as configured by `http-verbs.auditing.maxBodyLength`).
+See [README](/README.md) for details.
 
 ### WSProxyConfiguration
 
@@ -20,11 +21,6 @@ There are some differences with `WSProxyConfiguration.buildWsProxyServer`:
   * `proxy.proxyRequiredForThisEnvironment` has been replaced with `http-verbs.proxy.enabled`, but note, it defaults to false (rather than true). This is appropriate for development and tests, but will need explicitly enabling when deployed.
 
 
-### Adds HttpClientV2
-This is in addition to `HttpClient` (for now), so can be optionally used instead.
-
-See [README](/README.md) for details.
-
 ## Version 13.12.0
 
 ### Supported Play Versions

diff --git a/README.md b/README.md
@@ -113,6 +113,15 @@ For streamed responses, use `stream` rather than `execute`:
 httpClientV2.get(url"$url").stream[Source[ByteString, _]]
 ```
 
+#### Auditing
+
+HttpClientV2 truncates payloads for audit logs if they exceed the max supported (as configured by `http-verbs.auditing.maxBodyLength`).
+
+This means audits that were rejected for being too large with HttpClient will probably be accepted with HttpclientV2.
+
+:warning: Please check any potential impact this may have on auditing performance.
+
+
 ### URL interpolator
 
 A [URL interpolator](https://sttp.softwaremill.com/en/latest/model/uri.html) has been provided to help with escaping query and parameters correctly.