lesstif / php-jira-rest-client

PHP classes interact Jira with the REST API.
Other
510 stars 261 forks source link

Add New Method for Returning Board List With Offset/Paginated Results #535

Closed nickpoulos closed 1 week ago

nickpoulos commented 3 months ago

The current implementation of the BoardService->getBoardList() method will only return the first 50 results from the Jira Board endpoint (/rest/agile/1.0/board).

Rather than modify the existing getBoardList() method and introduce a breaking change, I created a new method -- getBoards() -- which maps the response data from /rest/agile/1.0/board into a newly created BoardResult object. This new object has properties for data like total results, and a isLast boolean, which are returned by the endpoint but currently ignored by getBoardList().

Using this new object data, developers can easily make multiple calls to the /rest/agile/1.0/board endpoint to retrieve the entire list of boards rather than just the first 50.

I added this information to the ReadMe and added an additional test.

Let me know what you think.

Thanks.