Update documents API for Meilisearch v.28

[alallema]

Pull Request

Related to: meilisearch/integration-guides#205

What does this PR do?

Breaking because enforces the users to use Meilisearch v0.28.0

• 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.
• The documents objects now return wrap in a Results
• Create two separate methods for GET /documents:
  • <T> Results<T> getDocuments(Class<T> targetClass) throws MeilisearchException -> return an Object
  • String getRawDocuments() -> return a String
• Create two separate methods for GET /documents/:uid:
  • <T> Results<T> getDocument(String identifier, Class<T> targetClass) throws MeilisearchException -> return an Object
  • String getRawDocument(String identifier) -> return a String
• Adapt DocumentsQuery naming following all the routes
• Adapt and fix tests
• Add test for getRawDocument
• Add test for getRawDocuments

[brunoocasali]

I left a comment, but it applies to every occurrence of the queries :)

I really think it will improve the complexity of the code :)

[brunoocasali]

You have to also add support to fields, which allows the user to reduce the payload meilisearch will return like we have here: https://github.com/meilisearch/meilisearch-python/blob/a6dc0631103a495d109ff6b69e288193d1b22b73/tests/index/test_index_document_meilisearch.py#L71-L78.

[brunoocasali]

This can be used in the getDocuments, getDocument, getRawDocuments, and getRawDocument

[bidoubiwa]

Could you go over the different method documentations to update

• The explanations
• The @param param
• The return statement

I started suggesting on a lot of them

[bidoubiwa]

can you use toQuery here?

[alallema]

There already is an overload of toQuery with 2 String as parameters:
public String toQuery(String uid, String identifier)
So I can create a new one but with another name like toQueryWithPrimaryKey ...

[bidoubiwa]

I think it would be:

    public String toQuery(String uid, String identifier, String primaryKey) {

Which I don't think exists yet in the toQuery

But yes, it becomes to specific... so you are right. Until we find something more generic your solution is maybe better.

@brunoocasali what do you think?

[alallema]

I think it would be:
public String toQuery(String uid, String identifier, String primaryKey) {

It could but we don't use identifier

[alallema]

@brunoocasali what do you think?
Same