all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: "Lukas Wagner" <l.wagner@proxmox.com>
To: "Proxmox Datacenter Manager development discussion"
	<pdm-devel@lists.proxmox.com>
Subject: Re: [pdm-devel] [PATCH proxmox v2 4/5] docgen: add docgen crate
Date: Wed, 19 Nov 2025 14:13:50 +0100	[thread overview]
Message-ID: <DECP5AV3FM0N.3MNQEOIEABW0N@proxmox.com> (raw)
In-Reply-To: <20251113120021.331639-5-s.sterz@proxmox.com>

One comment inline.

On Thu Nov 13, 2025 at 1:00 PM CET, Shannon Sterz wrote:
> diff --git a/proxmox-docgen/src/lib.rs b/proxmox-docgen/src/lib.rs
> new file mode 100644
> index 00000000..b3ef1ff8
> --- /dev/null
> +++ b/proxmox-docgen/src/lib.rs
> @@ -0,0 +1,322 @@
> +use serde_json::{json, Value};
> +
> +use proxmox_router::{ApiAccess, ApiHandler, ApiMethod, Permission, Router, SubRoute};
> +use proxmox_schema::format::get_property_string_type_text;
> +use proxmox_schema::{ApiStringFormat, ObjectSchemaType, Schema};
> 

This should have some API docs :)

> +pub fn generate_api_tree(router: &Router, path: &str, privileges: &[(&str, u64)]) -> Value {
> +    let mut data = dump_api_schema(router, path, privileges);
> +    data["expanded"] = true.into();
> +    data
> +}
> +


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


  reply	other threads:[~2025-11-19 13:14 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-13 12:00 [pdm-devel] [PATCH datacenter-manager/proxmox{, -backup}/widget-toolkit v2 0/9] unstable flag and pdm api viewer Shannon Sterz
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-19 13:13   ` Lukas Wagner [this message]
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
2025-11-19 13:13 ` [pdm-devel] [PATCH datacenter-manager/proxmox{, -backup}/widget-toolkit v2 0/9] unstable flag and pdm api viewer Lukas Wagner
2025-11-19 13:46   ` Shannon Sterz
2025-11-19 14:16 ` [pdm-devel] Superseded: " 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=DECP5AV3FM0N.3MNQEOIEABW0N@proxmox.com \
    --to=l.wagner@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