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

[Shannon Sterz <s.sterz@proxmox.com>]

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.

Follow Ups
----------

* currently the proxmox-docgen handles AllOf schemas that have
  additional properties that are not object schema to always have
  additoinal properties. otherwise, a panic would be caused in
  proxmox-schema. the proper fix here is to adapt schema generation in
  pve-api-types that is caused by some properties being generated as
  string schemas that wrap a property string.

  the correct way of handling those would be to either fix
  proxmox-schema to also handle these types of schema without panicing
  or to not generate these type of schema in the first place.

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:

Shannon Sterz (4):
  router/api-macro: add unstable flag for ApiMethod
  docgen: add docgen crate
  docgen: add support for the new stable flag
  docgen: add a stop-gap fix to allow generating schema for
    pve-api-types

 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           | 339 ++++++++++++++++++++++++++++
 proxmox-router/src/router.rs        |  10 +
 9 files changed, 444 insertions(+), 1 deletion(-)
 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-backup:

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

 Cargo.toml                 |   3 +
 docs/api-viewer/index.html |   2 +
 src/bin/docgen.rs          | 312 +------------------------------------
 3 files changed, 10 insertions(+), 307 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                      | 308 +-----------------
 8 files changed, 63 insertions(+), 306 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:
  21 files changed, 533 insertions(+), 616 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