From: Dominik Csapak <d.csapak@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH http-server] fix #6503: return api handler errors in the json body
Date: Wed, 8 Jan 2025 10:58:53 +0100 [thread overview]
Message-ID: <20250108095853.896087-1-d.csapak@proxmox.com> (raw)
similar to what we do for the extjs formatter, put the error message or
status message in the 'message' property of the return object.
This way client libraries can extract the error without having to parse
the HTTP status reason phrase (which is not possible in all http
libraries, e.g. hyperium's http rust crate).
This should not be a breaking change, since it just adds a (semi) new
field to the return value.
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
we could of course put the error also in the 'errors' hash with a
special key like '_api', but i opted for mirroring the 'extjs' formatter
behaviour for consistency.
src/PVE/APIServer/Formatter/Standard.pm | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/src/PVE/APIServer/Formatter/Standard.pm b/src/PVE/APIServer/Formatter/Standard.pm
index 5211473..eca928d 100644
--- a/src/PVE/APIServer/Formatter/Standard.pm
+++ b/src/PVE/APIServer/Formatter/Standard.pm
@@ -33,6 +33,10 @@ sub prepare_response_data {
$res->{status} = 200;
}
$new->{success} = $success;
+ } elsif ($format eq 'json') {
+ if (HTTP::Status::is_error($res->{status})) {
+ $new->{message} = "$res->{message}" || status_message($res->{status});
+ }
}
if ($success && $res->{total}) {
--
2.39.5
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
reply other threads:[~2025-01-08 9:59 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250108095853.896087-1-d.csapak@proxmox.com \
--to=d.csapak@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox