Skip to content

Add support for response metadata in dataProvider.getList() #10179

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Sep 4, 2024
Merged

Add support for response metadata in dataProvider.getList() #10179

merged 5 commits into from
Sep 4, 2024

Conversation

fzaninotto
Copy link
Member

Closes #9569

Problem

Even though some API backends return additional data in the getList results (e.g. facets and other aggregations), there is currently no way to access them.

Solution

Update useGetList and ListContext to return any meta property present in the API response.

@fzaninotto fzaninotto added the WIP Work In Progress label Sep 2, 2024
@fzaninotto fzaninotto added RFR Ready For Review and removed WIP Work In Progress labels Sep 2, 2024
djhi
djhi requested changes Sep 4, 2024
View reviewed changes
Copy link
Collaborator

@djhi djhi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a great addition 👍

@fzaninotto @djhi
Update docs/List.md
9ddadb5 
Co-authored-by: Gildas Garcia <[email protected]>
@djhi djhi added this to the 5.2.0 milestone Sep 4, 2024
@djhi djhi merged commit f8ff8a0 into next Sep 4, 2024
14 checks passed
@djhi djhi deleted the response-metadata branch September 4, 2024 08:35
@fzaninotto fzaninotto mentioned this pull request Sep 4, 2024
Closed
@fzaninotto fzaninotto mentioned this pull request Nov 26, 2024
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@djhi djhi djhi approved these changes

Assignees
No one assigned
Labels
RFR Ready For Review
Milestone
5.2.0
Development

Successfully merging this pull request may close these issues.
2 participants
@fzaninotto @djhi