API resource output as class to utilize dot notation for attributes #513
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alallema
reviewed
Aug 8, 2022
There was a problem hiding this comment.
Thanks, @ElamC for this PR ❤️
And well done you do a great job, the only feedback I have is my fault for not having detailed enough the outcome. On the naming, we decided with the team that all returns with results would be called such as: NameOfTheClassResults.
e.g: DocumentsResults, IndexesResults, TaskResults, KeysResults.
So sorry for the naming inconvenience.
|
Thanks for the feedback @alallema. Just made a few changes |
alallema
reviewed
Aug 8, 2022
|
A note on the changes: document model allows for attributes to be accessed like |
alallema
reviewed
Aug 16, 2022
alallema
reviewed
Aug 17, 2022
alallema
approved these changes
Aug 22, 2022
|
bors merge |
alallema
added
the
breaking-change
bors bot
added a commit
that referenced
this pull request
Sep 21, 2022
533: Update version for the next release (v0.20.0) r=brunoocasali a=alallema Update to the next version **Note:** This release is a replacement for the v0.19.2 which should be a minor update instead of a patch update. https://github.com/meilisearch/meilisearch-python/releases/tag/v0.19.2 ## 💥 Breaking changes * API resource output as class to utilize dot notation for attributes (#513) `@ElamC` * `Document`, `Index` and `Task` are now class and the attributes of these classes are now accessible via dot notation: * `document.offset`, `document.limit`, `document.total` * `task.uid`, `task.duration`, `task.status` ... * Add pipenv install in the CONTRIBUTING guide (#519) `@brunoocasali` * Bump mako from 1.2.1 to 1.2.2 due to security issue (#528) Thanks again to `@ElamC,` `@alallema,` `@brunoocasali!` 🎉 Co-authored-by: alallema <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
What does this PR do?
Fixes #508
PR checklist
Please check if your PR fulfills the following requirements:
Thank you so much for contributing to Meilisearch!