[pmg-devel] [PATCH pmg-api v2 1/1] fix #3450: api: queue: add POST endpoint for batch deletion/delivery

[Thomas Lamprecht]

Am 24.09.25 um 07:43 schrieb Hannes Laimer:
> On 23.09.25 15:22, Thomas Lamprecht wrote:
>> Am 23.09.25 um 11:33 schrieb Hannes Laimer:

>>> - single POST endpoitn that takes type(delete/deliver) and list of id's
>>
>> Fine for delivery, but why not add a new optional ids parameter to the
>> existing DELETE endpoint?
>>
> 
> To have it mentioned here, the reason is that
> DELETE doesn't take data, at least our proxy doesn't, and something like
> `.../{queue}/?ids=AABC234,DDEF4543,EEFG6473,...`
> is at best odd and brittle.

Meh, nothing should speak against DELETE taking a body from a technical
POV, but fair enough.

> I should have included this and I'll add it for v3.

Yes, please do!

>>> diff --git a/src/PMG/API2/Postfix.pm b/src/PMG/API2/Postfix.pm
>>> index ba0689c..90a74e9 100644
>>> --- a/src/PMG/API2/Postfix.pm
>>> +++ b/src/PMG/API2/Postfix.pm
>>> @@ -335,6 +335,49 @@ __PACKAGE__->register_method({
>>>       },
>>>   });
>>>   +__PACKAGE__->register_method({
>>> +    name => 'queue_action',
>>> +    path => 'queue/{queue}',
>>> +    method => 'POST',
>>> +    description => "Perform an action on the given queue IDs (delete/deliver).",
>>> +    proxyto => 'node',
>>> +    permissions => { check => ['admin'] },
>>> +    protected => 1,
>>> +    parameters => {
>>> +        additionalProperties => 0,
>>> +        properties => {
>>> +            node => get_standard_option('pve-node'),
>>> +            queue => $queue_name_option,
>>> +            action => {
>>> +                description => 'Operation to perform on the given IDs.',
>>> +                type => 'string',
>>> +                enum => ['delete', 'deliver'],
>>> +            },
>>> +            id => {
>>
>> "ids" would slightly better signal that this can be more than one.
>>
>>> +                description => 'Queue ID(s), separated by semicolons (;).',
>>> +                type => 'string',
>>> +                pattern => '[A-Za-z0-9]{8,20}(;[A-Za-z0-9]{8,20})*',
>>
>> hmm, don't we have a format for this or at least an existing regex
>> we can reuse?
>>
> 
> not really, there's only
> ```
> my $queue_id_option = {
>     description => "The Message queue ID.",
>     type => 'string',
>     pattern => '[a-zA-Z0-9]+',
>     minLength => 8,
>     maxLength => 20,
> };
> ```
> but I don't think a thing for just `[a-zA-Z0-9]+` adds much.

it's obviously trivial and indeed does not add much on it's own
from a low-level POV, but these can be abstractions that still help
to argue and reason about the code nonetheless; that said, I'm fine
with deciding some not so hard cuts on a case by case basis, and for
me it can be fine to keep this as is then if there is nothing factored
out already.