fix for #577

[danFbach]

Pull Request

Related issue

Fixes #577

What does this PR do?

• brings the Offset, Limit and EstimatedTotalHits fields to ISearchable<T>
• migrated fields in SearchResult<T> now use /// <inheritdoc/> as docs were also moved to ISearchable<T>

PR checklist

Please check if your PR fulfills the following requirements:

• Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
• Have you read the contributing guidelines?
• Have you made sure that the title is accurate and descriptive of the changes?

Not sure if Offset and Limit also need to ported up, but i could envision a scenario where it would be useful, so I brought them along too.

[migueltarga]

Awesome!

[danFbach]

I think I would retract this PR. There should probably be separate interfaces for offset and paginated results. This would better conform with API result object, which is polymorphic based on the request. Is this more what you all would be looking for?

[migueltarga]

The way you have it looks completely fine to me:
https://www.meilisearch.com/docs/reference/api/search#response

[danFbach]

@migueltarga The problem is that they already have both SearchResult<T> and PaginatedSearchResult<T> as implementations of ISearchable<T> This should enable you to do something like this...

For paginated results.

var results = await index.SearchAsync<MeilisearchResultProductModel>(query, new SearchQuery()
{
    ShowRankingScore = true,
    Page = page,
    HitsPerPage = pageSize,
    Filter = buildFilter(categoryIds, manufacturerId, currentStoreId),
});

if (results is PaginatedSearchResult<MeilisearchResultProductModel> paginatedResult)
{
    var totalPages = paginatedResult.TotalPages
}

Or for offset style request:

if (results is SearchResult<MeilisearchResultProductModel> searchResult)
{
    var totalHits = searchResult.EstimatedTotalHits;
}

Will be testing this shortly and will report if it works as expected.

[danFbach]

@migueltarga I can confirm that the following syntax is valid.

var results = await index.SearchAsync<T>(query, new SearchQuery()
{
    Limit = 5,
    Offset = 0,
    ShowRankingScore = true
});

if (results is SearchResult<T> resultModel)
{
    var estimatedTotalHits = resultModel.EstimatedTotalHits;
}

Docs should probably be updated to make this more obvious.

[migueltarga]

@danFbach Thank you for the explanation and the example!