Add missing paging parameters in declared OpenAPI endpoints #4695

New issue

Closed

opened 2026-02-20 06:06:36 -05:00 by deekerman · 0 comments

deekerman commented

2026-02-20 06:06:36 -05:00

Owner

Originally created by @Ezwen on GitHub (Sep 5, 2023).

Is there an existing issue for this?

I have searched the existing open and closed issues

The following Sonarr API endpoints provide paginated responses:

/blocklist
/wanted/cutoff
/wanted/missing
/history
/log
/queue

In particular, the page parameter can be used to ask these endpoints a specific page.

For example, this query is valid and works well

$ curl   -H "X-Api-Key: XXXXX" -X GET "http://my.local.sonarr:8989/api/v3/queue?page=2"

However, in the Sonarr OpenAPI definition file, the paging parameters that these endpoints accept are not declared nor documented.

A consequence it that tools that rely on this definition file, for instance the sonarr-py library, do not provide any way to query specific pages in these endpoints.

Describe the solution you'd like

I would expect the Sonarr OpenAPI definition file to define all parameters that all endpoints accept − and in particular the paging parameters mentioned above.

Describe alternatives you've considered

I don't see any for now

Anything else?

Issue opened on sonarr-py because their client code for the queue endpoint is not usable due to a lack of paging parameters: https://github.com/devopsarr/sonarr-py/issues/41

Originally created by @Ezwen on GitHub (Sep 5, 2023). ### Is there an existing issue for this? - [X] I have searched the existing open and closed issues ### Is your feature request related to a problem? Please describe The following Sonarr API endpoints provide paginated responses: - `/blocklist` - `/wanted/cutoff` - `/wanted/missing` - `/history` - `/log` - `/queue` In particular, the `page` parameter can be used to ask these endpoints a specific page. For example, this query is valid and works well ``` $ curl -H "X-Api-Key: XXXXX" -X GET "http://my.local.sonarr:8989/api/v3/queue?page=2" ``` However, in the [Sonarr OpenAPI definition file](https://github.com/Sonarr/Sonarr/blob/develop/src/Sonarr.Api.V3/openapi.json), the paging parameters that these endpoints accept are not declared nor documented. A consequence it that tools that rely on this definition file, for instance the [sonarr-py library](https://github.com/devopsarr/sonarr-py/), do not provide any way to query specific pages in these endpoints. ### Describe the solution you'd like I would expect the [Sonarr OpenAPI definition file](https://github.com/Sonarr/Sonarr/blob/develop/src/Sonarr.Api.V3/openapi.json) to define all parameters that all endpoints accept − and in particular the paging parameters mentioned above. ### Describe alternatives you've considered I don't see any for now ### Anything else? Issue opened on sonarr-py because their client code for the queue endpoint is not usable due to a lack of paging parameters: https://github.com/devopsarr/sonarr-py/issues/41

deekerman

2026-02-20 06:06:36 -05:00

closed this issue
added the
enhancement

docs
labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/Sonarr#4695

No description provided.

Rows
Columns