[pdm-devel] [PATCH manager 2/3] api: termproxy: add description to return schema

[Stefan Hanreich]

On 11/11/25 9:29 AM, Fabian Grünbichler wrote:
> needed to call this endpoint from PDM.
> 
> Signed-off-by: Fabian Grünbichler <f.gruenbichler at proxmox.com>
> ---
>  PVE/API2/Nodes.pm | 11 +++++++----
>  1 file changed, 7 insertions(+), 4 deletions(-)
> 
> diff --git a/PVE/API2/Nodes.pm b/PVE/API2/Nodes.pm
> index 459e0ed0a..53e3af08f 100644
> --- a/PVE/API2/Nodes.pm
> +++ b/PVE/API2/Nodes.pm
> @@ -1328,10 +1328,13 @@ __PACKAGE__->register_method({
>      returns => {
>          additionalProperties => 0,
>          properties => {
> -            user => { type => 'string' },
> -            ticket => { type => 'string' },
> -            port => { type => 'integer' },
> -            upid => { type => 'string' },
> +            user => {
> +                type => 'string',
> +                description => 'user/token that generated the VNC ticket in `ticket`',
> +            },
> +            ticket => { type => 'string', description => 'VNC ticket used to verifiy websocket connection' },

nit: typo + needs make tidy

> +            port => { type => 'integer', description => 'port used to bind termproxy to' },
> +            upid => { type => 'string', description => 'UPID for termproxy worker task' },
>          },
>      },
>      code => sub {