From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id 9640F1FF179 for ; Wed, 15 Oct 2025 16:03:39 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 1E1F61D4B3; Wed, 15 Oct 2025 16:03:57 +0200 (CEST) From: Nicolas Frey To: pve-devel@lists.proxmox.com Date: Wed, 15 Oct 2025 16:03:50 +0200 Message-ID: <20251015140350.176989-1-n.frey@proxmox.com> X-Mailer: git-send-email 2.47.3 MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.044 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment KAM_LAZY_DOMAIN_SECURITY 1 Sending domain does not have any anti-forgery methods RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RDNS_NONE 0.793 Delivered to internal network by a host with no rDNS SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_NONE 0.001 SPF: sender does not publish an SPF Record Subject: [pve-devel] [PATCH proxmox-widget-toolkit] fix #6830: ui: apiviewer: add description panel to return section 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: , Reply-To: Proxmox VE development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" The PVE API viewer does not display schema object descriptions. For example, when an endpoint's return type is defined like this: `returns => { type => 'object', description => 'Some Description.', ... }` the description field would not be shown anywhere in the API viewer. This patch adds a panel above the properties table, which shows the description of the object if it is set. Fixes: https://bugzilla.proxmox.com/show_bug.cgi?id=6830 Signed-off-by: Nicolas Frey --- src/api-viewer/APIViewer.js | 101 ++++++++++++++++++++---------------- 1 file changed, 55 insertions(+), 46 deletions(-) diff --git a/src/api-viewer/APIViewer.js b/src/api-viewer/APIViewer.js index 57d4451..7f27e0d 100644 --- a/src/api-viewer/APIViewer.js +++ b/src/api-viewer/APIViewer.js @@ -390,55 +390,64 @@ Ext.onReady(function () { }); sections.push({ - xtype: 'gridpanel', + xtype: 'panel', title: 'Returns: ' + rtype, - features: [groupingFeature], - store: rpstore, - viewConfig: { - trackOver: false, - stripeRows: true, - enableTextSelection: true, - }, - columns: [ - { - header: 'Name', - dataIndex: 'name', - flex: 1, - }, - { - header: 'Type', - dataIndex: 'type', - renderer: render_type, - flex: 1, - }, + items: [ + info.returns.description ? { + html: Ext.htmlEncode(info.returns.description), + bodyPadding: '5px 10px 5px 10px', + } : {}, { - header: 'Default', - dataIndex: 'default', - flex: 1, - }, - { - header: 'Format', - dataIndex: 'type', - renderer: render_format, - flex: 2, - }, - { - header: 'Description', - dataIndex: 'description', - renderer: render_description, - flex: 6, - }, - ], - bbar: [ - { - xtype: 'button', - text: 'Show RAW', - handler: function (btn) { - rawSection.setVisible(!rawSection.isVisible()); - btn.setText(rawSection.isVisible() ? 'Hide RAW' : 'Show RAW'); + xtype: 'gridpanel', + features: [groupingFeature], + store: rpstore, + viewConfig: { + trackOver: false, + stripeRows: true, + enableTextSelection: true, }, - }, - ], + columns: [ + { + header: 'Name', + dataIndex: 'name', + flex: 1, + }, + { + header: 'Type', + dataIndex: 'type', + renderer: render_type, + flex: 1, + }, + { + header: 'Default', + dataIndex: 'default', + flex: 1, + }, + { + header: 'Format', + dataIndex: 'type', + renderer: render_format, + flex: 2, + }, + { + header: 'Description', + dataIndex: 'description', + renderer: render_description, + flex: 6, + }, + ], + bbar: [ + { + xtype: 'button', + text: 'Show RAW', + handler: function (btn) { + rawSection.setVisible(!rawSection.isVisible()); + btn.setText(rawSection.isVisible() ? 'Hide RAW' : 'Show RAW'); + }, + }, + ], + } + ] }); sections.push(rawSection); -- 2.47.3 _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel