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 1C45C1FF17E for ; Thu, 13 Nov 2025 12:59:36 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id C19B619F23; Thu, 13 Nov 2025 13:00:28 +0100 (CET) From: Shannon Sterz To: pdm-devel@lists.proxmox.com Date: Thu, 13 Nov 2025 13:00:18 +0100 Message-ID: <20251113120021.331639-7-s.sterz@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20251113120021.331639-1-s.sterz@proxmox.com> References: <20251113120021.331639-1-s.sterz@proxmox.com> MIME-Version: 1.0 X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1763035198401 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.061 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 SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pdm-devel] [PATCH widget-toolkit v2 1/1] api viewer: add support for endpoints that are marked as unstable X-BeenThere: pdm-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Datacenter Manager development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Datacenter Manager development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pdm-devel-bounces@lists.proxmox.com Sender: "pdm-devel" display a warning when an endpoint is marked as unstable. Signed-off-by: Shannon Sterz --- src/api-viewer/APIViewer.js | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/src/api-viewer/APIViewer.js b/src/api-viewer/APIViewer.js index 7f27e0d..1357741 100644 --- a/src/api-viewer/APIViewer.js +++ b/src/api-viewer/APIViewer.js @@ -210,7 +210,21 @@ Ext.onReady(function () { usage += cliUsageRenderer(method, endpoint); } - let sections = [ + let sections = []; + + if (info.unstable) { + sections.push({ + title: 'Unstable', + html: `
+ + This API endpoint is marked as unstable. All information on this + page is subject to change, including input parameters, return values + and permissions. +
`, + }); + } + + sections.concat([ { title: 'Description', html: Ext.htmlEncode(info.description), @@ -221,7 +235,7 @@ Ext.onReady(function () { html: usage, bodyPadding: 10, }, - ]; + ]); if (info.parameters && info.parameters.properties) { let pstore = Ext.create('Ext.data.Store', { -- 2.47.3 _______________________________________________ pdm-devel mailing list pdm-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pdm-devel