Skip to content

Update documents for v0.28.0 #317

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 77 commits into from
Aug 29, 2022
Merged

Update documents for v0.28.0 #317

merged 77 commits into from
Aug 29, 2022

Conversation

@bidoubiwa
Copy link
Contributor

Related to: meilisearch/meilisearch#2372

All the changes:

  • GET /documents/:uid, GET /documents Add the possibility to reduce the body payload by using a query parameter called fields (previously called attributesToRetrieve), check the issue and the spec for the entire behavior.
  • Wrap the objects in a results key.
  • GET /documents has pagination metadata, added limit (default: 20), offset (default: 0), total.
  • ⚠️ The displayedAttributes settings do not impact anymore the displayed fields returned in the /documents endpoints. These settings only affect the /search endpoint.

bidoubiwa added 30 commits August 3, 2022 14:28
@bidoubiwa
Update task api v0.28.0
a37ffd3
@bidoubiwa
Update tests to be relevant with the structures where they are ran
b9ffd60
@bidoubiwa
Update types in code-samples
c527312
@bidoubiwa
Remove clearAll task type
17d6c19
@bidoubiwa
Add index_uid as an optional in the Tasks
ff0d350
@bidoubiwa
Add comments on best builder implementation
9241a7b
@bidoubiwa
Add execute function on get_tasks
eb38d18
@bidoubiwa
Update code samples
d37be56
@bidoubiwa
Remove out of context comment
61be5a5
@bidoubiwa
Merge
7aa409b
@bidoubiwa
Fix tests
c968df3
@bidoubiwa
Fix pagination tests
c21b18f
@bidoubiwa
Update HTTP methods for v0.28.0
012f939
@bidoubiwa
Fix clippy
0cb9e93
@bidoubiwa
Merge branch 'update_task_api_for_v0.28.0' of github.com:meilisearch/…
a485ba5 
…meilisearch-rust into update_http_methods_for_v0.28.0
@bidoubiwa
Remove comment of task tests since the tests are now sucesful
f86bff4
@bidoubiwa
Fix doc tests
734fd13
@bidoubiwa
Merge branch 'update_task_api_for_v0.28.0' of github.com:meilisearch/…
e5821c4 
…meilisearch-rust into update_http_methods_for_v0.28.0
@bidoubiwa
Update keys for v0.28.0
11bfb7e
@bidoubiwa
Fix get tasks inside index structure
6b70f5a
@bidoubiwa
Make description and name optional in keys
604e08d
@bidoubiwa
Fix none doc tests with new get_tasks api
67637c2
@bidoubiwa
Add from and limit in tasks params
c2dcd92
@bidoubiwa
Add warning on failing test
efff813
@bidoubiwa
Merge branch 'update_task_api_for_v0.28.0' of https://github.com/meil…
f0020b6 
…isearch/meilisearch-rust into update_http_methods_for_v0.28.0
@bidoubiwa
Merge
e0762b1
@bidoubiwa
Update keys design
c1796a3
@bidoubiwa
Update task API
abc0f7b
@bidoubiwa
Remove useless comment
eaef1ea
@bidoubiwa
Merge branch 'update_task_api_for_v0.28.0' of https://github.com/meil…
bdf4f13 
…isearch/meilisearch-rust into update_http_methods_for_v0.28.0
@bidoubiwa bidoubiwa changed the base branch from main to update_search_for_v0.28.0 August 24, 2022 17:49
Base automatically changed from update_search_for_v0.28.0 to bump-meilisearch-v0.28.0 August 25, 2022 12:04
@bidoubiwa bidoubiwa marked this pull request as ready for review August 25, 2022 12:25
@bidoubiwa bidoubiwa requested review from alallema and irevoire August 25, 2022 12:25
@bidoubiwa bidoubiwa added the breaking-change The related changes are breaking for the users label Aug 25, 2022
alallema
alallema reviewed Aug 25, 2022
View reviewed changes
Copy link
Contributor

@alallema alallema left a comment

Choose a reason for hiding this comment

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

Great 🔥 !!! Just some comments

@bidoubiwa bidoubiwa requested review from alallema August 29, 2022 09:05
bidoubiwa
bidoubiwa commented Aug 29, 2022
View reviewed changes
bidoubiwa
bidoubiwa commented Aug 29, 2022
View reviewed changes
@bidoubiwa bidoubiwa merged commit 0150f1c into bump-meilisearch-v0.28.0 Aug 29, 2022
@bidoubiwa bidoubiwa deleted the update_documents_for_v0.28.0 branch August 29, 2022 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alallema alallema Awaiting requested review from alallema

1 more reviewer

@irevoire irevoire irevoire approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

breaking-change The related changes are breaking for the users

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@bidoubiwa @irevoire @alallema