Enhance API board details with card information on detail=true

[erseco]

• Target version: main

Summary

This enhancement proposal aims to reduce server load and improve client performance by extending the functionality of the detail=true parameter in board details fetching. Specifically, it introduces the inclusion of card information within the detail=true response, minimizing the necessity for additional requests to obtain related cards for each stack within a board.

This proposal calls the new method enrichWithCards, in BoardService.php, which appends card details to each stack of a board when detail=true is specified. Additionally, I suggest the future development of a enrichWithComments method to further consolidate data retrieval by including comment information with each card.

TODO

• Call enrichWithCards method to include card details in detail=true board responses.
• Discuss and plan the development of enrichWithComments for future integration.

Checklist

• Code is properly formatted
• Sign-off message is added to all commits
• Tests (unit, integration, api and/or acceptance) are included
• Documentation (manuals or wiki) has been updated or is not required

[juliusknorr]

Thanks a lot for the contribution. I'm a bit unsure to which level we should actually extend the existing output. Enhancing with all cards of a board could easily run into troubles on the server side with larger boards where all card data would need to be put in memory during the request. I will need to think about this a bit more, but generally prefer to rather have incremental data fetching through API endpoints which can also more easily be load balanced and scaled on the infrastructure side then having one long running request.

[github-actions]

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!