Virtual host limit endpoints documentation is confusing and incorrect

[deadanon]

Steps to reproduce:

Create at least one vhost limit.
GET /api/vhost-limits via REST API

[
    {
        "vhost": "local",
        "value": {
            "max-connections": 50
        }
    }
]

Attempt to change limit via
PUT /api/vhost-limits/vhost/local
BODY {"max-connections": 100}

{
    "error": "not_found",
    "reason": "vhost_not_found"
}

[lukebakken]

I can reproduce this using RabbitMQ 3.7.12, thanks -

$ curl -4u 'guest:guest' -H 'content-type: application/json' -X PUT localhost:15672/api/vhost-limits/vhost/local -d '{"max-connections":50}'
{"error":"not_found","reason":"vhost_not_found"}

[michaelklishin]

Here are the routes. The endpoint in question is

"/vhost-limits/:vhost/:name"

The {vhost} parameter is expected to be the virtual host name and the {name} one is the limit name. So you are not using the endpoint correctly.

[lukebakken]

@michaelklishin we've got to fix the docs then - https://cdn.rawgit.com/rabbitmq/rabbitmq-management/v3.7.12/priv/www/api/index.html

[michaelklishin]

I agree with that. The docs provide an incorrect payload example and this language is confusing:

Set or delete per-vost limit for vhost with name

What the name refers to is not at all clear.

[lukebakken]

Yep. I've got to figure out exactly how to make the requests, since this ain't it:

$ curl -4u 'guest:guest' -X PUT localhost:15672/api/vhost-limits/local/max-connections -d 50

$ curl -4u 'guest:guest' localhost:15672/api/vhost-limits/local
[]

[michaelklishin]

The docs also claim that /api/vhost-limits/{vhost} only supports GET requests but the code says it does support PUT. It is not a copy-paste artifact because PUT support was introduced in f608459.

[lukebakken]

Voila, this works:

$ curl -4u 'guest:guest' -H 'content-type:application/json' -X PUT localhost:15672/api/vhost-limits/local/max-connections -d '{"value": 50}'

@deadanon ^^^^