Row fetch endpoint that also accepts filters and sort rules
- Dominant language
- JavaScript
- Stars
- 214
- Forks
- 52
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 82
Description
Contributes to #941
For pagination we need to have a endpoint, that fetches the rows of a table or view also in consideration of user supplied filter and sorting rules.
The current controller methods of \OCA\Tables\Controller\Api1Controller (indexTableRows and indexViewRows) accept parameters for pagination, but that is it.
In this context it makes sense to integrate the approaches of https://github.com/nextcloud/tables/pull/927 and create a new v2 endpoint.
The current v1 endpoint shall be deprecated, as it is already not used by the web frontend. It should not be removed (the android app might make use of it – needs to be verified).
The internal endpoints (\OCA\Tables\Controller\RowController::index() and ::indexView()) shall be deprecated, and later on removed as soon as the web interfaces also switches to the v2 endpoint.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing linked pull request #1565 and the current methods in \OCA\Tables\Controller\Api1Controller::indexTableRows and indexViewRows. Compare the internal RowController::index() and ::indexView() endpoints to the proposed v2 design. Done means a v2 row-fetch endpoint supports pagination, user filters, and sorting, while the v1 and internal endpoints are deprecated and retained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, php
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100