Skip to content

Commit 750eb7d

Browse files
committed
Update changelog with change details
1 parent 1e75fce commit 750eb7d

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

Diff for: docs/changelog/90529.yaml

+17-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,24 @@
11
pr: 90529
22
summary: Output a consistent format when generating error json
33
area: Infra/REST API
4-
type: "breaking, bug"
4+
type: bug
55
issues:
66
- 89387
77
breaking:
8-
title: Output a consistent format when generating error json
9-
area: Infra/REST API
10-
details: Please describe the details of this change for the release notes. You can
11-
use asciidoc.
12-
impact: Please describe the impact of this change to users
8+
title: >-
9+
Error JSON structure has changed when detailed errors are disabled
10+
area: REST API
11+
details: |-
12+
This change modifies the JSON format of error messages returned to REST clients
13+
when detailed messages are turned off.
14+
Previously, JSON returned when an exception occurred, and `http.detailed_errors.enabled: false` was set,
15+
just consisted of a single `"error"` text field with some basic information.
16+
Setting `http.detailed_errors.enabled: true` (the default) changed this field
17+
to an object with more detailed information.
18+
With this change, non-detailed errors now have the same structure as detailed errors. `"error"` will now always
19+
be an object with, at a minimum, a `"type"` and `"reason"` field. Additional fields are included when detailed
20+
errors are enabled.
21+
impact: >-
22+
If you have set `http.detailed_errors.enabled: false` (the default is `true`) the structure of JSON
23+
when any exceptions occur now matches the structure when detailed errors are enabled.
1324
notable: false

0 commit comments

Comments
 (0)