From: Shannon Sterz <s.sterz@proxmox.com>
To: pdm-devel@lists.proxmox.com
Subject: [pdm-devel] [PATCH widget-toolkit 1/1] api viewer: add support for endpoints that are marked as unstable
Date: Wed, 12 Nov 2025 11:24:08 +0100 [thread overview]
Message-ID: <20251112102415.175358-2-s.sterz@proxmox.com> (raw)
In-Reply-To: <20251112102415.175358-1-s.sterz@proxmox.com>
display a warning when an endpoint is marked as unstable.
Signed-off-by: Shannon Sterz <s.sterz@proxmox.com>
---
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: `<div class="proxmox-warning-row" style="padding: 10px;">
+ <i class="fa fa-exclamation-triangle" aria-hidden="true"></i>
+ This API endpoint is marked as unstable. All information on this
+ page is subject to change, including input parameters, return values
+ and permissions.
+ </div>`,
+ });
+ }
+
+ 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
next prev parent reply other threads:[~2025-11-12 10:23 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-12 10:24 [pdm-devel] [PATCH datacenter-manager/proxmox{, -backup}/widget-toolkit 0/8] unstable flag and pdm api viewer Shannon Sterz
2025-11-12 10:24 ` Shannon Sterz [this message]
2025-11-12 10:24 ` [pdm-devel] [PATCH proxmox 1/4] router/api-macro: add unstable flag for ApiMethod Shannon Sterz
2025-11-12 10:24 ` [pdm-devel] [PATCH proxmox 2/4] docgen: add docgen crate Shannon Sterz
2025-11-12 10:24 ` [pdm-devel] [PATCH proxmox 3/4] docgen: add support for the new stable flag Shannon Sterz
2025-11-12 10:24 ` [pdm-devel] [PATCH proxmox 4/4] docgen: add a stop-gap fix to allow generating schema for pve-api-types Shannon Sterz
2025-11-12 16:09 ` Shannon Sterz
2025-11-12 10:24 ` [pdm-devel] [PATCH proxmox-backup 1/1] docgen: use proxmox-rs docgen crate Shannon Sterz
2025-11-12 10:24 ` [pdm-devel] [PATCH datacenter-manager 1/2] docgen: switch to " Shannon Sterz
2025-11-12 10:24 ` [pdm-devel] [PATCH datacenter-manager 2/2] api-viewer: add an api-viewer package Shannon Sterz
2025-11-13 12:02 ` [pdm-devel] Superseded: Re: [PATCH datacenter-manager/proxmox{, -backup}/widget-toolkit 0/8] unstable flag and pdm api viewer Shannon Sterz
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=20251112102415.175358-2-s.sterz@proxmox.com \
--to=s.sterz@proxmox.com \
--cc=pdm-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.