[Meilisearch v1.44.0] Add human-formatted sizes and detailed DB sizes in stats

[Strift]

Context

[Meilisearch 1.44.0]https://github.com/meilisearch/meilisearch/releases/tag/v1.44.0) introduces human-formatted sizes and detailed DB sizes in stats.

Objective

Update the corresponding SDK methods:

• Get stats of index
• Get stats of all indexes

Both related API endpoints now accept new query parameters:

• showInternalDatabaseSizes: boolean, optional, defaults to false. When present, the index stat objects in responses of the stat routes now contain an additional internalDatabaseSizes key, whose value is a dictionary of the internal database names and their current size in the index, like in the stats object of a batch.
• sizeFormat: human or raw: optional, defaults to raw. When present and set to human, then all database sizes in responses of the stat routes will be returned as a string containing an appropriate unit (MiB, GiB, etc). When missing or set to raw, then the current behavior of expressing the size in bytes as a number is retained.

The keys in internalDatabaseSizes are subject to change and should not be exposed as a strongly typed object.

Tasks

• Add/update methods to handle interacting with the stats API endpoints
• Add/update test cases for the new/updated methods
• Update .code-samples.meilisearch.yaml to add examples under the following keys: get_index_stats_1 and get_indexes_stats_1. It should match the examples in the documentation.

[Moustafa-Ameen]

Hi, I’d like to work on this issue if it is still available.

I’m a CS student with Java/backend API experience, and this looks like a good fit because it involves extending existing SDK methods, handling optional query parameters, updating response models, and adding tests/code samples.

My initial plan would be to:

1. Review the existing stats-related methods for index stats and global stats.
2. Add support for the new optional query parameters: showInternalDatabaseSizes and sizeFormat.
3. Update the stats response handling so internalDatabaseSizes is represented flexibly as a dictionary/map rather than a strongly typed object.
4. Add or update tests covering the default raw-size behavior and the new human-formatted/internal-size options.
5. Update .code-samples.meilisearch.yaml for get_index_stats_1 and get_indexes_stats_1 to match the documentation examples.

Would it be okay if I start investigating this and open a focused PR?

[Strift]

Hello and thanks for your interest!

You are welcome to open a PR for this, but we prefer not to assign issues.

This sometimes discourages other contributors from opening a PR, and we've met users who asked to be assigned and never came back.

We are looking forward to reviewing your PR!