all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Shannon Sterz <s.sterz@proxmox.com>
To: pdm-devel@lists.proxmox.com
Subject: [pdm-devel] [PATCH datacenter-manager/proxmox{, -backup}/widget-toolkit v2 0/9] unstable flag and pdm api viewer
Date: Thu, 13 Nov 2025 13:00:12 +0100	[thread overview]
Message-ID: <20251113120021.331639-1-s.sterz@proxmox.com> (raw)

this series adds a flag that marks certain api endpoints as unstable.
allowing for more fine grained control over when and what we declare to
be stable. it also adds an api viewer to pdm as a separate package that
is only suggested for now.

the code that dumps api definitions as json is also moved to proxmox-rs
and unified between pdm and pbs to reduce technical debt.

Changelog
---------

* add a patch that fixes a generation bug in pve by Wolfgang Bumiller.
  this replaces a previous patch that worked around that bug in
  proxmox-docgen.
* add a patch cleaning up some clippy lints in pve-api-types
* clean up some unused import in the docgen binary in pbs & pdm

proxmox:

Shannon Sterz (4):
  router/api-macro: add unstable flag for ApiMethod
  pve-api-types: fix clippy lints
  docgen: add docgen crate
  docgen: add support for the new stable flag

Wolfgang Bumiller (1):
  pve-api-types: generate array objects

 Cargo.toml                          |   1 +
 proxmox-api-macro/src/api/method.rs |   9 +-
 proxmox-docgen/Cargo.toml           |  20 ++
 proxmox-docgen/debian/changelog     |   5 +
 proxmox-docgen/debian/control       |  36 ++++
 proxmox-docgen/debian/copyright     |  18 ++
 proxmox-docgen/debian/debcargo.toml |   7 +
 proxmox-docgen/src/lib.rs           | 323 ++++++++++++++++++++++++++++
 proxmox-router/src/router.rs        |  10 +
 pve-api-types/src/types/array.rs    |   4 +-
 pve-api-types/src/types/macros.rs   | 147 ++++++++++++-
 pve-api-types/src/types/mod.rs      |   3 +
 12 files changed, 578 insertions(+), 5 deletions(-)
 create mode 100644 proxmox-docgen/Cargo.toml
 create mode 100644 proxmox-docgen/debian/changelog
 create mode 100644 proxmox-docgen/debian/control
 create mode 100644 proxmox-docgen/debian/copyright
 create mode 100644 proxmox-docgen/debian/debcargo.toml
 create mode 100644 proxmox-docgen/src/lib.rs


proxmox-widget-toolkit:

Shannon Sterz (1):
  api viewer: add support for endpoints that are marked as unstable

 src/api-viewer/APIViewer.js | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)


proxmox-backup:

Shannon Sterz (1):
  docgen: use proxmox-rs docgen crate

 Cargo.toml                 |   3 +
 docs/api-viewer/index.html |   2 +
 src/bin/docgen.rs          | 326 ++-----------------------------------
 3 files changed, 20 insertions(+), 311 deletions(-)


proxmox-datacenter-manager:

Shannon Sterz (2):
  docgen: switch to proxmox-rs docgen crate
  api-viewer: add an api-viewer package

 Cargo.toml                                    |   2 +
 Makefile                                      |   1 +
 debian/control                                |  13 +
 ...xmox-datacenter-manager-api-viewer.install |   1 +
 docs/api-viewer/Makefile                      |  27 ++
 docs/api-viewer/index.html                    |  16 +
 server/Cargo.toml                             |   1 +
 server/src/bin/docgen.rs                      | 314 +-----------------
 8 files changed, 65 insertions(+), 310 deletions(-)
 create mode 100644 debian/proxmox-datacenter-manager-api-viewer.install
 create mode 100644 docs/api-viewer/Makefile
 create mode 100644 docs/api-viewer/index.html


Summary over all repositories:
  24 files changed, 679 insertions(+), 628 deletions(-)

--
Generated by git-murpp 0.8.1


_______________________________________________
pdm-devel mailing list
pdm-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pdm-devel


             reply	other threads:[~2025-11-13 12:00 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-13 12:00 Shannon Sterz [this message]
2025-11-13 12:00 ` [pdm-devel] [PATCH proxmox v2 1/5] router/api-macro: add unstable flag for ApiMethod Shannon Sterz
2025-11-13 12:00 ` [pdm-devel] [PATCH proxmox v2 2/5] pve-api-types: generate array objects Shannon Sterz
2025-11-13 12:00 ` [pdm-devel] [PATCH proxmox v2 3/5] pve-api-types: fix clippy lints Shannon Sterz
2025-11-13 12:00 ` [pdm-devel] [PATCH proxmox v2 4/5] docgen: add docgen crate Shannon Sterz
2025-11-13 12:00 ` [pdm-devel] [PATCH proxmox v2 5/5] docgen: add support for the new stable flag Shannon Sterz
2025-11-13 12:00 ` [pdm-devel] [PATCH widget-toolkit v2 1/1] api viewer: add support for endpoints that are marked as unstable Shannon Sterz
2025-11-13 12:00 ` [pdm-devel] [PATCH proxmox-backup v2 1/1] docgen: use proxmox-rs docgen crate Shannon Sterz
2025-11-13 12:00 ` [pdm-devel] [PATCH datacenter-manager v2 1/2] docgen: switch to " Shannon Sterz
2025-11-13 12:00 ` [pdm-devel] [PATCH datacenter-manager v2 2/2] api-viewer: add an api-viewer package 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=20251113120021.331639-1-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.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal