Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] document Content-Type breaking change from 8.0 #116845

Merged
merged 4 commits into from
Nov 19, 2024
+17 −0
Merged

[DOCS] document Content-Type breaking change from 8.0 #116845

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5f7e3c2
[DOCS] document breaking change from 8.0
shainaraskas Nov 14, 2024
9a37bab
Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc
shainaraskas Nov 18, 2024
fe05c72
Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc
shainaraskas Nov 19, 2024
6a52f6d
Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc
shainaraskas Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc
View file
Open in desktop
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.
shainaraskas marked this conversation as resolved.
Show resolved Hide resolved

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
----
====