Repository navigation
Add meili get version - #35
Conversation
A singleton resource, so rule 2 gives `get version`, and the route has neither a path nor a query parameter: the command is `get health` with a key action, `version`, the one the document declares on it. That key action is the whole difference between the two: `GET /health` declares none and answers without a key, `GET /version` refuses one the instance does not accept, which the tests pin at exit 3. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Command and route registration src/commands/get/version.ts, oclif.manifest.json, docs/contract/commands.md, .changeset/first-version.md |
The command requests GET /version and sends the response to output(). The manifest registers get:version, and the command reference and changeset document the command. |
Command validation test/helpers/meilisearch-handlers.ts, test/commands/get/version.test.ts, test/integration/meilisearch/get-version.test.ts |
Mocked and integration tests cover help output, successful version responses, and invalid API keys. The mocked handler returns fixed version and commit data. |
Priority:
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Feature
Merge Risk: 
1db11
-
No merge-blocking issue is identified; run the normal checks before merging.
Pre-merge checks: 
-
Check name Status Explanation Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title "Add meili get version" names the primary change. The changeset adds themeili get versioncommand, which callsGET /versionand reports the Meilisearch instance version and build comm…Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Title check
-
Explanation
The title "Add
meili get version" names the primary change. The changeset adds themeili get versioncommand, which callsGET /versionand reports the Meilisearch instance version and build commit. The title is specific, short, and free of file lists or vague terms, so a teammate scanning history can identify the change.
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 4 files. (3 skipped: 3 unsupported.)
-
Finishing Touches
-
📝 Generate docstrings
-
- Commit to this branch
- Create a new PR
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Comment @coderabbitai help to get the list of available commands.
What
Add
meili get version, the one route ofGET /version.Contract
docs/contract/commands.md, and each route is reachable by a distinct set of flags, or the exception is recorded with its reason (or this pull request changes the contract and nothing else)src/lib/output.ts, errors throughsrc/lib/errors.ts$EDITOR; adeletecommand spreadsBaseCommand.confirmFlagsand its examples carry--yesfetchoutsidesrc/lib/clients/Tests
--helpsnapshot added or updated on purposepnpm lint,pnpm typecheck,pnpm testpass locallySimplicity
src/lib/, is used by this command, and is named belowDocs
docs/contract/updated for every name, flag, variable or code this change adds or renames, or nothing to updateHousekeeping
oclif.manifest.jsonregeneratedNotes for the reviewer
No shared code added, no dependency, no exception. The command is fifteen lines: the resource is a singleton, so rule 2 gives
get versionand the route has neither a path nor a query parameter. It is the smallest command of the tree,get healthwith a key action.Two things worth a look:
keyActions = ["version"]. The document declaresBearer: ["version", "*"]on this route, so the specific action isversion, notversion.get: the contract test reads it from the document and would fail on the other spelling. It is also what makes this command different fromget health, which declaressecurity: []and works without a key.The error case is the key the instance refuses, 403 with
invalid_api_key, exit 3, snapshotted in the unit test and run for real in the integration test with a wrong key. There is no 404 to pin here: the route takes nothing.Ran the
simplifyskill on the diff: reuse, simplification and altitude, which found two small things, both applied — the msw handler's comment restated its three field names, and the changeset line explained the key action at a level its neighbours do not, which belongs here rather than in the changelog. I did not run the efficiency angle: the command makes one call, sets up no fixture and declares no flag of its own.🤖 Generated with Claude Code
Summary by CodeRabbit
meili get versionto retrieve the Meilisearch instance version and build information.