📝 better docs for model search - #484
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
Changes are limited to documentation improvements and non-invasive test strengthening with no functional logic modifications.
Pull request overview
This PR improves the clarity of the V2 “Model Search” API documentation and slightly strengthens the integration test to validate that returned models include expected core fields.
Changes:
- Clarifies
ModelSearchclass documentation (scope, optional filters, and pagination). - Refines inline parameter docs for
ModelSearchParameters(nameandmodelType). - Adds assertions in the model search integration test to verify
id,name, andmodelTypeare present on returned models.
File summaries
| File | Description |
|---|---|
tests/v2/search/modelSearch.integration.ts |
Adds per-model field presence assertions to make integration coverage more robust. |
src/v2/search/models/modelSearchParameters.ts |
Updates parameter JSDoc to better describe filtering behavior. |
src/v2/search/models/modelSearch.ts |
Expands class-level JSDoc to clarify scope, optional filters, and pagination. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Types of changes