From 5f7e3c2064228d665689f9c89fc23f942e3dac19 Mon Sep 17 00:00:00 2001 From: shainaraskas Date: Thu, 14 Nov 2024 15:37:12 -0500 Subject: [PATCH 1/4] [DOCS] document breaking change from 8.0 --- .../migrate_8_0/rest-api-changes.asciidoc | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc b/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc index 99c09b9b05385..9c842a741c5b2 100644 --- a/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc +++ b/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc @@ -1136,3 +1136,21 @@ 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, as UTF is 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 +---- +// NOTCONSOLE +==== \ No newline at end of file From 9a37bab7121733f93c238d5f14af49abe8427bd4 Mon Sep 17 00:00:00 2001 From: shainaraskas <58563081+shainaraskas@users.noreply.github.com> Date: Mon, 18 Nov 2024 08:45:37 -0500 Subject: [PATCH 2/4] Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc --- docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc b/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc index 9c842a741c5b2..0c8f41d76fd8b 100644 --- a/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc +++ b/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc @@ -1152,5 +1152,4 @@ As a workaround, to render non-ASCII characters, include an HTTP `Accept` header ---- Accept: application/json; charset=utf-8 ---- -// NOTCONSOLE ==== \ No newline at end of file From fe05c72e321406132bfdee2b351eb2530b33f00a Mon Sep 17 00:00:00 2001 From: shainaraskas <58563081+shainaraskas@users.noreply.github.com> Date: Tue, 19 Nov 2024 10:02:46 -0500 Subject: [PATCH 3/4] Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc --- docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc b/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc index 0c8f41d76fd8b..0a131a8392144 100644 --- a/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc +++ b/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc @@ -1141,7 +1141,7 @@ To detect a server timeout, check the `timed_out` field of the JSON response. [%collapsible] ==== *Details* + -The `Content-Type` response header no longer specifies the charset. This information is not required when transferring JSON data, as UTF is the default encoding. +The `Content-Type` response header no longer specifies the charset. This information is not required when transferring JSON data, because JSON text is always 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. From 6a52f6d2127ae428baffa9b9724250b1717b75ac Mon Sep 17 00:00:00 2001 From: shainaraskas <58563081+shainaraskas@users.noreply.github.com> Date: Tue, 19 Nov 2024 10:03:53 -0500 Subject: [PATCH 4/4] Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc --- docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc b/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc index 0a131a8392144..85fc4160ea071 100644 --- a/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc +++ b/docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc @@ -1141,7 +1141,7 @@ To detect a server timeout, check the `timed_out` field of the JSON response. [%collapsible] ==== *Details* + -The `Content-Type` response header no longer specifies the charset. This information is not required when transferring JSON data, because JSON text is always encoded in Unicode, with UTF-8 being the default encoding. +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.