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.

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

v0.28: Document API changes #1700

Closed
guimachiavelli opened this issue Jun 7, 2022 · 0 comments · Fixed by #1707 or #1736
Closed

v0.28: Document API changes #1700

guimachiavelli opened this issue Jun 7, 2022 · 0 comments · Fixed by #1707 or #1736
Assignees
@guimachiavelli
Milestone
v0.28

Comments

@guimachiavelli
Copy link
Member

v0.28 introduces three main changes to /documents.

Resource pagination

As the name implies, getting a list of documents now returns paginated results using the new parameters limit and offset. Response bodies include a results array, together with limit, offset, and total fields.

Rename attributesToRetrieve to fields

The API endpoint for getting documents attributesToRetrieve is now called fields. This is to reduce confusion with the similarly named search parameter attributesToRetrieve.

displayedAttributes

There is no longer any relationship between displayedAttributes, the index setting, and the fields returned by the documents endpoint. Previously, attributesToRetrieve (now fields) would use the displayedAttributes list by default.

References

Specs:
@guimachiavelli guimachiavelli added this to the v0.28 milestone Jun 7, 2022
@guimachiavelli guimachiavelli self-assigned this Jun 9, 2022
@guimachiavelli guimachiavelli mentioned this issue Jun 15, 2022
Merged
@guimachiavelli guimachiavelli linked a pull request Jun 15, 2022 that will close this issue
v0.28 #1707
Merged
@guimachiavelli guimachiavelli mentioned this issue Jun 16, 2022
Merged
bors bot added a commit that referenced this issue Jun 30, 2022
@bors @maryamsulemani97 @guimachiavelli
Merge #1732 #1734 #1736
4a53358 
1732: v0.28: API endpoint verbs update r=guimachiavelli a=maryamsulemani97

closes #1702 

1734: v0.28: /search name changes r=guimachiavelli a=maryamsulemani97

closes #1692

1736: v0.28: Changes to `/documents` r=guimachiavelli a=guimachiavelli

Closes #1700

Co-authored-by: Maryam Sulemani <[email protected]>
Co-authored-by: gui machiavelli <[email protected]>
Co-authored-by: gui machiavelli <[email protected]>
bors bot added a commit that referenced this issue Jul 11, 2022
@bors @guimachiavelli
@dichotommy @maryamsulemani97
Merge #1707
00cb6df 
1707: v0.28 r=guimachiavelli a=guimachiavelli

This is a staging PR for all changes related to Meilisearch v0.28.

Please avoid making changes directly to this PR; instead, create new child branches based off this one.

Closes #1687, #1688, #1691, #1692, #1693, #1694, #1699, #1700, #1701, #1702, #1703, #1704, #1706, #1722, #1727, #561

Co-authored-by: gui machiavelli <[email protected]>
Co-authored-by: gui machiavelli <[email protected]>
Co-authored-by: Tommy Melvin <[email protected]>
Co-authored-by: Maryam Sulemani <[email protected]>
Co-authored-by: Maryam <[email protected]>
@bors bors bot closed this as completed in #1707 Jul 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@guimachiavelli guimachiavelli

Labels
None yet
Projects
None yet
Milestone
v0.28
Development

Successfully merging a pull request may close this issue.

v0.28 meilisearch/documentation
v0.28: Changes to /documents meilisearch/documentation
1 participant
@guimachiavelli