[pdm-devel] [RFC PATCH proxmox] pve api types: percent encode string params in url

[Lukas Wagner]

On Fri Nov 28, 2025 at 1:59 PM CET, Dominik Csapak wrote:
> when we generate an url for the pve api from something like
>
> "/some/{foo}/thing/{bar}"
>
> then the url we generate will be wrapped in a `format!` and the
> variables `foo` and `bar` will be inserted into the url.
>
> Sometimes, these parameters can contain invalid characters for a url and
> we have to percent encode them.
>
> To do that, we convert the url to one with unnamed parameters and add
> them with percent encoding.
>
> The order of the url_params is the same as in the url, so we don't
> have to to a lookup or similar, simply iterating over that is enough.
>
> This fixes an issue with UPIDs that contain the character '>'.
> (e.g. move disk from one vm to another).
>
> Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
> ---
> sending as RFC, because there is a (not so generic) alternative:
> we could simply percent encode the upid ourselves in pdm, whenever
> we call the pve api.

I think handling encoding at this level as implemented in this patch is
exactly right.

>
> but since this wasn't too hard to do and everything seems to work
> in my (albeit short) tests, I wanted to send it and gather feedback.
>
>  pve-api-types/generator-lib/Schema2Rust.pm | 29 +++++++++++++++++++++-
>  pve-api-types/src/client/code.rs           |  2 ++
>  2 files changed, 30 insertions(+), 1 deletion(-)
>

Couldn't find anything that looked off. Everything seems to work fine
after applying this patch, refreshing the bindings and building PDM with
them. Verified in the browser console that non-alphanumeric characters
are indeed percent-encoded. Also spot-checked the diff of the generated code,
everything that I saw looked reasonable.

Reviewed-by: Lukas Wagner <l.wagner at proxmox.com>
Tested-by: Lukas Wagner <l.wagner at proxmox.com>