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

[FEATURE REQUEST] Pagination for list of assets in AvailableAssets #427

Open
jckastel opened this issue Mar 1, 2022 · 1 comment · May be fixed by #491
Open

[FEATURE REQUEST] Pagination for list of assets in AvailableAssets #427

jckastel opened this issue Mar 1, 2022 · 1 comment · May be fixed by #491
Assignees
Labels
breaking This issue leads to a major version WT1 To be discussed at the next meeting
Milestone

Comments

@jckastel
Copy link

jckastel commented Mar 1, 2022

Is your feature request related to a problem? Please describe.

The /operator/available-assets API response currently contains an optional assets field which contains a list of individual Assets. However, this list could grow quite large and there is currently no way to limit the number of entries in this list. The list is required by certain third parties that make use of TOMP, such as CROW. There are pagination settings for the query as a whole starting from v1.1.0, but these presumably apply to the list of asset types, not to the nested list of individual assets per type.

Urgency

Major; at least one party already makes use of this functionality and it could lead to performance issues for parties with large numbers of assets. See also issue #425 for additional reasons why pagination should be required.

Describe the solution you'd like

Aside from the existing pagination options for AssetTypes, we would like to add pagination support to the lists of assets.

Possible Implementation

Note that, since there are multiple lists of assets (i.e. one per type), to do this properly and in a way that is clear to developers, it may be desirable to split the existing AvailableAssets endpoint into two parts; one for requesting the list of asset types (without the assets field that currently exists in 1.3.0), and one endpoint to request assets of a specific type in a follow-up request, with both endpoints supporting pagination.

@edwinvandenbelt edwinvandenbelt added WT1 To be discussed at the next meeting WT2 and removed WT1 To be discussed at the next meeting labels Mar 9, 2022
@edwinvandenbelt edwinvandenbelt added this to the Elephant - 2.0 milestone Mar 9, 2022
@edwinvandenbelt edwinvandenbelt added breaking This issue leads to a major version WT1 To be discussed at the next meeting and removed WT2 labels Mar 9, 2022
@edwinvandenbelt edwinvandenbelt self-assigned this Mar 8, 2023
@edwinvandenbelt edwinvandenbelt linked a pull request Mar 8, 2023 that will close this issue
@edwinvandenbelt
Copy link
Collaborator

Use HAL in v2.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking This issue leads to a major version WT1 To be discussed at the next meeting
Projects
Status: In review V2.0
Status: In review V2.0
Development

Successfully merging a pull request may close this issue.

2 participants