A Collection Aspect is defined as an Aspect with a Model which defines a single Property with a Collection Characteristic on root level. Additionally such an Aspect Model may define more scalar Properties on root level. For such an Aspect, paging could (in most use cases probably should) be provided since the data set provided by the Aspect may be very large.
In order to support paging for Collection Aspects, the developer guide must include a specification of how to implement this and the POJO generation, provided as part of the SDK, must include paging attributes for Collection Aspects. The JSON mapping definition must include a section on paging attributes as well.
Including paging attributes in the generated POJO should work in the same manner as the generation of the paging attributes in the OpenAPI specification generation. The paging attributes are generated by default and the user is provided with the option to generate the attributes for time-base-paging, offset-based-paging or cursor-based-paging. The user is also provided with the option to exclude the paging attributes from the generated code.
atextor
commented
2 days ago
Description
A Collection Aspect is defined as an Aspect with a Model which defines a single Property with a Collection Characteristic on root level. Additionally such an Aspect Model may define more scalar Properties on root level. For such an Aspect, paging could (in most use cases probably should) be provided since the data set provided by the Aspect may be very large.
In order to support paging for Collection Aspects, the developer guide must include a specification of how to implement this and the POJO generation, provided as part of the SDK, must include paging attributes for Collection Aspects. The JSON mapping definition must include a section on paging attributes as well.
Including paging attributes in the generated POJO should work in the same manner as the generation of the paging attributes in the OpenAPI specification generation. The paging attributes are generated by default and the user is provided with the option to generate the attributes for time-base-paging, offset-based-paging or cursor-based-paging. The user is also provided with the option to exclude the paging attributes from the generated code.