From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id EE08392491 for ; Wed, 12 Oct 2022 15:24:22 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id D0B1D261F4 for ; Wed, 12 Oct 2022 15:23:52 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Wed, 12 Oct 2022 15:23:51 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 53D0C43EF5 for ; Wed, 12 Oct 2022 15:23:51 +0200 (CEST) From: Matthias Heiserer To: pve-devel@lists.proxmox.com Date: Wed, 12 Oct 2022 15:23:31 +0200 Message-Id: <20221012132332.301805-1-m.heiserer@proxmox.com> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.210 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pve-devel] [PATCH widget-toolkit 1/2] api-viewer: fix #4271: display nested formats instead of [object Object] X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 12 Oct 2022 13:24:23 -0000 I tried to keep the format as close to the HTML docs as possible, but there are a few discrepancies between HTML docs and how this patch displays parameters: Instead of ,the enum variants are displayed. [1] Instead of <0|1>, is displayed. [1] The HTML docs explain parameters after the initial format string, which the GUI doesn't (and there's no space for that). Showing the variants inline is the easiest way to not loose information here. Signed-off-by: Matthias Heiserer --- src/api-viewer/APIViewer.js | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/src/api-viewer/APIViewer.js b/src/api-viewer/APIViewer.js index c6580bb..2b04b8c 100644 --- a/src/api-viewer/APIViewer.js +++ b/src/api-viewer/APIViewer.js @@ -79,6 +79,27 @@ Ext.onReady(function() { return pdef.enum ? 'enum' : pdef.type || 'string'; }; + const renderFormatString = function(obj) { + if (!Ext.isObject(obj)) { + return obj; + } + const mandatory = []; + const optional = []; + Object.entries(obj).forEach(function([name, param]) { + let list = param.optional ? optional : mandatory; + let str = param.default_key ? `[${name}=]` : `${name}=`; + if (param.alias) { + return; + } else if (param.enum) { + str += `(${param.enum?.join(' | ')})`; + } else { + str += `<${param.format_description || param.pattern || param.type}>`; + } + list.push(str); + }); + return mandatory.join(", ") + ' ' + optional.map(each => `[,${each}]`).join(' '); + }; + let render_simple_format = function(pdef, type_fallback) { if (pdef.typetext) { return pdef.typetext; @@ -87,7 +108,7 @@ Ext.onReady(function() { return pdef.enum.join(' | '); } if (pdef.format) { - return pdef.format; + return renderFormatString(pdef.format); } if (pdef.pattern) { return pdef.pattern; -- 2.30.2