Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support paging for Collection Aspects #18

Open
georgschmidtdumont opened this issue Sep 21, 2021 · 1 comment
Open

Support paging for Collection Aspects #18

georgschmidtdumont opened this issue Sep 21, 2021 · 1 comment
Labels
acknowledged Has been viewed by one of the maintainers and is ready for further work, discussion or other steps. enhancement New feature or request

Comments

@georgschmidtdumont
Copy link
Contributor

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.

@georgschmidtdumont georgschmidtdumont added the enhancement New feature or request label Sep 21, 2021
@chris-volk chris-volk added the acknowledged Has been viewed by one of the maintainers and is ready for further work, discussion or other steps. label Feb 21, 2023
@atextor
Copy link
Contributor

atextor commented Nov 25, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
acknowledged Has been viewed by one of the maintainers and is ready for further work, discussion or other steps. enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants