meilisearch / meilisearch/meilisearch-php
[Meilisearch v1.53.0] Add `indexSize` and `usedIndexSize` to index stats
Open
Beginner friendly
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- PHP
- Stars
- 757
- Forks
- 125
- Avg merge
- 6d 8h
- Merged PRs (30d)
- 2
Description
Context
Meilisearch v1.53.0 adds indexSize and usedIndexSize to per-index stats.
Objective
Update the SDK so index stats responses include the new indexSize and usedIndexSize fields returned by Get stats of index and per index in Get stats of all indexes.
indexSize: size of the index DB (bytes by default; honoursizeFormatwhen supported)usedIndexSize: size of the used pages of the index DB (bytes by default; honoursizeFormatwhen supported)
Tasks
- Add
indexSizeandusedIndexSizeto the index stats response shape - Update test cases
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the SDK's index stats response shape and its existing test cases, using the Get stats of index and Get stats of all indexes endpoints as the starting points. Add coverage for indexSize and usedIndexSize, including sizeFormat behavior where supported, and finish when both fields are represented and the tests pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- api
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 75/100