[pdm-devel] [PATCH datacenter-manager/proxmox{, -backup}/widget-toolkit v4 0/9] unstable flag and pdm api viewer

Shannon Sterz s.sterz at proxmox.com
Fri Nov 21 17:04:38 CET 2025


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
---------

changes since v3:

* rebase on current master for each repo.
* drop a patch that was intended for a different series.

changes since v2 (thanks @ Lukas Wagner):

* rebase on current master for each repo
* add a doc comment to the public function in proxmox-docgen

changes since v1:

* 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           | 330 ++++++++++++++++++++++++++++
 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, 585 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, 686 insertions(+), 628 deletions(-)

--
Generated by git-murpp 0.8.1




More information about the pdm-devel mailing list