You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ofbiz.apache.org by "Divesh Dutta (Jira)" <ji...@apache.org> on 2026/07/07 11:04:00 UTC

[jira] [Created] (OFBIZ-13457) Define reusable paging model for OFBiz REST APIs

Divesh Dutta created OFBIZ-13457:
------------------------------------

             Summary: Define reusable paging model for OFBiz REST APIs
                 Key: OFBIZ-13457
                 URL: https://issues.apache.org/jira/browse/OFBIZ-13457
             Project: OFBiz
          Issue Type: Sub-task
          Components: framework
    Affects Versions: Upcoming Branch
            Reporter: Divesh Dutta
             Fix For: Upcoming Branch


While working on PWA applications, a need came up for reusable pagination support in OFBiz REST APIs. Some common mechanics, such as paging parameter normalization, partial result retrieval, and paged response construction, appear useful across endpoints. However, before introducing framework-level helper methods, it would be better to define the broader REST API paging approach and requirements first.

This sub-task is intended to capture and discuss the generic paging model for OFBiz REST APIs under the broader scope of {{{}OFBIZ-11328{}}}.

Topics to evaluate:
 * standard request parameters for paging
 * standard response metadata for paging
 * representation of current page position and page size
 * support for total result count
 * support for previous/next page navigation
 * whether previous/next page links should be included in responses
 * handling of number of previous/next pages or other navigation metadata
 * default and maximum page size behavior
 * compatibility with existing OFBiz paging conventions such as {{VIEW_INDEX}} and {{VIEW_SIZE}}
 * suitability for PWA and other REST API consumers

The goal is to agree on a generic, reusable REST paging design for OFBiz, and then derive implementation details from that design. 

Any proposed helper methods in {{RestApiUtil}} or elsewhere should be evaluated in the context of this agreed model.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)