Skip to content

Commit

Permalink
[DOCS] document Content-Type breaking change from 8.0 (#116845) (#1…
Browse files Browse the repository at this point in the history
…17056)

(cherry picked from commit fc987d8)
  • Loading branch information
shainaraskas authored Nov 19, 2024
1 parent c24af84 commit ca01a9a
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1136,3 +1136,20 @@ for both cases.
*Impact* +
To detect a server timeout, check the `timed_out` field of the JSON response.
====

.The `Content-Type` response header no longer specifies the charset.
[%collapsible]
====
*Details* +
The `Content-Type` response header no longer specifies the charset. This information is not required when transferring JSON data, because JSON text will always be encoded in Unicode, with UTF-8 being the default encoding.
*Impact* +
Some applications and utilities, such as PowerShell's https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/invoke-restmethod[Invoke-RestMethod], must receive charset information to display data correctly. If your application or utility relies on charset information in the `Content-Type` response header, UTF-8 encoded characters will be rendered incorrectly in the response body.
As a workaround, to render non-ASCII characters, include an HTTP `Accept` header in your requests, specifying the charset:
[source,sh]
----
Accept: application/json; charset=utf-8
----
====

0 comments on commit ca01a9a

Please sign in to comment.