plone / plone/plone.restapi

Batching : add some batch information

Open
#426 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

It would be very useful for development of frontend components related to pagination
to have a few more information in search results 'batching' property :

  • total number of pages, (pages_total)
  • pagesize (page_size)
  • current page number (current_page)

without having to parse it from '@id' string and then compute it. it looks trivial (except for current page number, which is a private attribute)

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 tracing how the search results 'batching' property is assembled and where pagination values are available. Expose pages_total, page_size, and current_page without requiring clients to parse the '@id' string, then verify the returned batching information for paginated search results.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.