Add pagination parameters to the get_document() method
#492
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
changed the title
get_document() method
bidoubiwa
reviewed
Jul 6, 2022
meilisearch/index.py
Outdated
| @@ -249,7 +249,7 @@ def search(self, query: str, opt_params: Optional[Dict[str, Any]] = None) -> Dic | |||
| body=body | |||
| ) | |||
|
|
|||
| def get_document(self, document_id: str) -> Dict[str, Any]: | |||
| def get_document(self, document_id: str, fields: Optional[List[str]] = None) -> Dict[str, Any]: | |||
There was a problem hiding this comment.
Do you prefer adding fields as a parameter of the function or a parameter object like on the other routes in case tomorrow we add new params on get_document ?
ex:
def get_document(self, document_id: str, parameters: Optional[Dict[str, Any]] = None) -> List[Dict[str, Any]]:
With that we can add new parameters for the get_document route without having to create new function parameters each time.
There was a problem hiding this comment.
It is a very good remark but is it worth making a parameter more complex in the risk that others are added, that may never happen.
There was a problem hiding this comment.
I asked the product team and it is quite likely! I will modify it
bidoubiwa
reviewed
Jul 6, 2022
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?
Add pagination parameters to the
get_document()methodFix if parameters is a list in
get_document()andget_tasks()