plone / plone/plone.restapi

Consistent use of batching in listings

Open
#348 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
109
Forks
107
Avg merge
2d 3h
Merged PRs (30d)
4

Description

Folderish types, collections and search results use batching.
We'll have to check if other endpoints with listings are lacking this. We might want to refactor listings that lack batching.
First stop: find out which endpoints and add a test for them.

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 identifying REST API endpoints that return listings, using the existing batching in folderish types, collections, and search results as the comparison point. Add tests for endpoints that lack batching and confirm the listing responses consistently support batching.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.