nextcloud / nextcloud/bookmarks

Add paging to folder contents REST API

Open
#1,023 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1.2k
Forks
189
Avg merge
5d 11h
Merged PRs (30d)
10

Description

Given a folder can have hundreds of children, it would be good to have paging on the new folder contents endpoint in the REST API. Something like:

get:: /public/rest/v2/folder/(int:folder_id)/children

:query int page: if this is non-negative, results will be paginated by 10 children per page. Default: ``0``.

I understand you've got a few issues on your hands. No rush :)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the implementation of the new folder contents REST endpoint at /public/rest/v2/folder/{folder_id}/children and read how it currently returns children. Add support for a non-negative page query parameter, with 10 children per page and a default of 0. Done means the endpoint consistently returns the requested page of folder contents.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.