Add New Method for Returning Board List With Offset/Paginated Results #535
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Create a new class to hold the entire result data of the response returned from the "/rest/agile/1.0/board" endpoint - The approach is very similar to how the existing IssueService->search() function works already
- Instead of updating the existing getAllBoards() method and create a breaking change, I introduced a new method getBoards() - This method calls to the same "/rest/agile/1.0/board" endpoint as getAllBoards() but it maps the value into the newly created BoardResult class rather than ArrayObject. - This allows the developer to determine if there are more results past the initial 50 on the first page, and get additional pages if necessary
- Created a new test method which performs the same test as the get_all_boards() test but using the updated result object instead
Add information about how to use the new getBoards() method to retrieve the entire list of board results
Nitpick-CI
reviewed
Jun 8, 2024
| * | ||
| * Test we can obtain the paginated board list. | ||
| */ | ||
| public function get_boards() : string |
There was a problem hiding this comment.
Method name BoardTest::get_boards is not in camel caps format
There was a problem hiding this comment.
...but neither is any other method in the this test class?
Is it more important to keep consistency within the file or attempt to bring one new method in line with our new standards? Let me know and I can adjust accordingly. 👍
Added these in order to pass StyleCI PR checks
I realized other methods in BoardService also did not have proper pagination built in. We will reuse this class in a more generic way for other methods such as getSprintsForBoard()
- Update our new getBoards() method to return PaginatedResult instead of BoardResult - Add new method getSprintsForBoard() which has support for pagination and uses PaginatedResult
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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/boardinto a newly created BoardResult object. This new object has properties for data like total results, and aisLastboolean, which are returned by the endpoint but currently ignored bygetBoardList().Using this new object data, developers can easily make multiple calls to the
/rest/agile/1.0/boardendpoint 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.