Updating documentation: Maximum Pagination Parameters in the HTTP API

[trondwj-uio]

Is your feature request related to a problem? Please describe.

While testing different pagination parameters for queues, exchanges, connections, and channels, I noticed that there is a maximum page size, which is not documented on the RabbitMQ Management HTTP API v3.13.7 page. At the bottom of the HTTP API page, there is information about the pagination parameters, such as the default value of page_size. I would like the maximum value to be documented in the same section.

I observed that when the page_size exceeds 500, almost all API paths return a client error (4xx). However, there are two paths where a server error (5xx) occurs instead: /api/vhosts/{vhost}/connections and /api/vhosts/{vhost}/channels. Is this behavior intentional?

Describe the solution you'd like

Update the documentation to include the maximum page size for pagination parameters. Additionally, review and document any other maximum values that are currently undocumented across the RabbitMQ Management HTTP API.

Describe alternatives you've considered

I currently do not have any alternatives.

Additional context

RabbitMQ v3.13.7

[michaelklishin]

@trondwj-uio yes, there is a maximum page size of 500, see

1. https://github.com/rabbitmq/rabbitmq-server/blob/main/deps/rabbitmq_management/src/rabbit_mgmt_util.erl#L518-L541
2. https://github.com/rabbitmq/rabbitmq-server/blob/main/deps/rabbitmq_management/src/rabbit_mgmt_util.erl#L62

I will update the v4.0.x version of the reference. There won't be any more open source 3.13.x releases, as that series is out of community support since September 2024.

[trondwj-uio]

Thanks for the quick response! I look forward to seeing the update in the v4.0.x version of the reference.